diff --git a/.buildkite/pipelines/performance/daily.yml b/.buildkite/pipelines/performance/daily.yml index 28f58d6c814ef..fdc4ae17d69a2 100644 --- a/.buildkite/pipelines/performance/daily.yml +++ b/.buildkite/pipelines/performance/daily.yml @@ -19,11 +19,11 @@ steps: depends_on: build key: tests - - label: ':shipit: Performance Tests dataset extraction for scalability benchmarking' - command: .buildkite/scripts/steps/functional/scalability_dataset_extraction.sh - agents: - queue: n2-2 - depends_on: tests + # - label: ':shipit: Performance Tests dataset extraction for scalability benchmarking' + # command: .buildkite/scripts/steps/functional/scalability_dataset_extraction.sh + # agents: + # queue: n2-2 + # depends_on: tests - label: ':chart_with_upwards_trend: Report performance metrics to ci-stats' command: .buildkite/scripts/steps/functional/report_performance_metrics.sh diff --git a/.buildkite/pipelines/pull_request/base.yml b/.buildkite/pipelines/pull_request/base.yml index eca8e8280d8e8..36989003428e2 100644 --- a/.buildkite/pipelines/pull_request/base.yml +++ b/.buildkite/pipelines/pull_request/base.yml @@ -75,10 +75,3 @@ steps: automatic: - exit_status: '-1' limit: 3 - - - command: .buildkite/scripts/steps/webpack_bundle_analyzer/build_and_upload.sh - label: 'Build Webpack Bundle Analyzer reports' - agents: - queue: c2-16 - key: webpack_bundle_analyzer - timeout_in_minutes: 60 diff --git a/.buildkite/pipelines/pull_request/deploy_cloud.yml b/.buildkite/pipelines/pull_request/deploy_cloud.yml index c6a15ec32e179..7185911953232 100644 --- a/.buildkite/pipelines/pull_request/deploy_cloud.yml +++ b/.buildkite/pipelines/pull_request/deploy_cloud.yml @@ -2,6 +2,10 @@ steps: - command: .buildkite/scripts/steps/cloud/build_and_deploy.sh label: 'Build and Deploy to Cloud' agents: - queue: n2-2 + queue: n2-2-spot depends_on: build timeout_in_minutes: 30 + retry: + automatic: + - exit_status: '-1' + limit: 3 diff --git a/.buildkite/pipelines/pull_request/webpack_bundle_analyzer.yml b/.buildkite/pipelines/pull_request/webpack_bundle_analyzer.yml new file mode 100644 index 0000000000000..f1e61875fa254 --- /dev/null +++ b/.buildkite/pipelines/pull_request/webpack_bundle_analyzer.yml @@ -0,0 +1,7 @@ +steps: + - command: .buildkite/scripts/steps/webpack_bundle_analyzer/build_and_upload.sh + label: 'Build Webpack Bundle Analyzer reports' + agents: + queue: n2-4-spot + key: webpack_bundle_analyzer + timeout_in_minutes: 60 diff --git a/.buildkite/scripts/pipelines/pull_request/pipeline.ts b/.buildkite/scripts/pipelines/pull_request/pipeline.ts index 0777eca88dca8..025a8b497c544 100644 --- a/.buildkite/scripts/pipelines/pull_request/pipeline.ts +++ b/.buildkite/scripts/pipelines/pull_request/pipeline.ts @@ -126,6 +126,10 @@ const uploadPipeline = (pipelineContent: string | object) => { pipeline.push(getPipeline('.buildkite/pipelines/pull_request/deploy_cloud.yml')); } + if (GITHUB_PR_LABELS.includes('ci:build-webpack-bundle-analyzer')) { + pipeline.push(getPipeline('.buildkite/pipelines/pull_request/webpack_bundle_analyzer.yml')); + } + pipeline.push(getPipeline('.buildkite/pipelines/pull_request/post_build.yml')); uploadPipeline(pipeline.join('\n')); diff --git a/.buildkite/scripts/steps/webpack_bundle_analyzer/build_and_upload.sh b/.buildkite/scripts/steps/webpack_bundle_analyzer/build_and_upload.sh index 4374cce2281f8..24d08f7d5dc0a 100755 --- a/.buildkite/scripts/steps/webpack_bundle_analyzer/build_and_upload.sh +++ b/.buildkite/scripts/steps/webpack_bundle_analyzer/build_and_upload.sh @@ -4,6 +4,8 @@ set -euo pipefail .buildkite/scripts/bootstrap.sh +export NODE_OPTIONS="--max-old-space-size=8192" + node scripts/build_kibana_platform_plugins.js --dist --profile mkdir -p built_assets/webpack_bundle_analyzer diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 2c39e3171b754..7377ea3ffe353 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -331,7 +331,7 @@ # Kibana Platform Security /packages/kbn-crypto/ @elastic/kibana-security /packages/kbn-handlebars/ @elastic/kibana-security -/src/core/server/http/csp/ @elastic/kibana-security @elastic/kibana-core +/packages/core/http/core-http-server-internal/src/csp/ @elastic/kibana-security @elastic/kibana-core /src/plugins/interactive_setup/ @elastic/kibana-security /test/interactive_setup_api_integration/ @elastic/kibana-security /test/interactive_setup_functional/ @elastic/kibana-security diff --git a/.github/workflows/on-merge.yml b/.github/workflows/on-merge.yml index 34e95749a9c5e..072767f0000eb 100644 --- a/.github/workflows/on-merge.yml +++ b/.github/workflows/on-merge.yml @@ -1,7 +1,5 @@ on: pull_request_target: - branches: - - main types: - closed - labeled @@ -12,12 +10,7 @@ jobs: runs-on: ubuntu-latest if: | github.event.pull_request.merged == true - && ( - contains(github.event.pull_request.labels.*.name, 'backport:prev-minor') - || contains(github.event.pull_request.labels.*.name, 'backport:prev-major') - || contains(github.event.pull_request.labels.*.name, 'backport:all-open') - || contains(github.event.pull_request.labels.*.name, 'backport:auto-version') - ) + && !contains(github.event.pull_request.labels.*.name, 'auto-backport') && ( ( github.event.action == 'labeled' && ( diff --git a/api_docs/actions.devdocs.json b/api_docs/actions.devdocs.json index 50d82f10e8ab6..62e98fed14cdf 100644 --- a/api_docs/actions.devdocs.json +++ b/api_docs/actions.devdocs.json @@ -762,13 +762,7 @@ "description": [], "signature": [ "(source: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", "HttpRequestExecutionSource" ], @@ -783,13 +777,7 @@ "label": "source", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/actions/server/lib/action_execution_source.ts", @@ -2278,13 +2266,7 @@ "description": [], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => Promise<", "PublicMethodsOf", "<", @@ -2308,13 +2290,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/actions/server/plugin.ts", @@ -2333,13 +2309,7 @@ "description": [], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", "PublicMethodsOf", "<", @@ -2363,13 +2333,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/actions/server/plugin.ts", diff --git a/api_docs/actions.mdx b/api_docs/actions.mdx index a022f19967a0b..b37fe3df21ad2 100644 --- a/api_docs/actions.mdx +++ b/api_docs/actions.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/actions title: "actions" image: https://source.unsplash.com/400x175/?github summary: API docs for the actions plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/advanced_settings.mdx b/api_docs/advanced_settings.mdx index 75a113a41c39b..d7284bf2ba87a 100644 --- a/api_docs/advanced_settings.mdx +++ b/api_docs/advanced_settings.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/advancedSettings title: "advancedSettings" image: https://source.unsplash.com/400x175/?github summary: API docs for the advancedSettings plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/aiops.mdx b/api_docs/aiops.mdx index 8fdcf98bea476..618ea5e1eb78d 100644 --- a/api_docs/aiops.mdx +++ b/api_docs/aiops.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/aiops title: "aiops" image: https://source.unsplash.com/400x175/?github summary: API docs for the aiops plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/alerting.devdocs.json b/api_docs/alerting.devdocs.json index 1490336adc3e9..a295486b63bc0 100644 --- a/api_docs/alerting.devdocs.json +++ b/api_docs/alerting.devdocs.json @@ -1510,13 +1510,7 @@ "description": [], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", "RulesClientApi" ], @@ -1531,13 +1525,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/alerting/server/plugin.ts", @@ -1556,13 +1544,7 @@ "description": [], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", "PublicMethodsOf", "<", @@ -1586,13 +1568,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/alerting/server/plugin.ts", @@ -3075,7 +3051,7 @@ "section": "def-common.RuleSnoozeSchedule", "text": "RuleSnoozeSchedule" }, - "; }) => Promise; unsnooze: ({ id, scheduleIds, }: { id: string; scheduleIds?: string[] | undefined; }) => Promise; updateSnoozedUntilTime: ({ id }: { id: string; }) => Promise; unmuteAll: ({ id }: { id: string; }) => Promise; muteInstance: ({ alertId, alertInstanceId }: ", + "; }) => Promise; unsnooze: ({ id, scheduleIds, }: { id: string; scheduleIds?: string[] | undefined; }) => Promise; updateSnoozedUntilTime: ({ id }: { id: string; }) => Promise; clearExpiredSnoozes: ({ id }: { id: string; }) => Promise; unmuteAll: ({ id }: { id: string; }) => Promise; muteInstance: ({ alertId, alertInstanceId }: ", "MuteOptions", ") => Promise; unmuteInstance: ({ alertId, alertInstanceId }: ", "MuteOptions", diff --git a/api_docs/alerting.mdx b/api_docs/alerting.mdx index 2ba9845c5a5ee..7b86f41380cf8 100644 --- a/api_docs/alerting.mdx +++ b/api_docs/alerting.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/alerting title: "alerting" image: https://source.unsplash.com/400x175/?github summary: API docs for the alerting plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/apm.devdocs.json b/api_docs/apm.devdocs.json index 5776ed08f3165..06c67d2dc2974 100644 --- a/api_docs/apm.devdocs.json +++ b/api_docs/apm.devdocs.json @@ -203,13 +203,7 @@ "; telemetryCollectionEnabled: boolean; metricsInterval: number; profilingEnabled: boolean; agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; }>>; getApmIndices: () => Promise<", "ApmIndicesConfig", ">; createApmEventClient: ({ request, context, debug, }: { debug?: boolean | undefined; request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "; context: ", "ApmPluginRequestHandlerContext", "; }) => Promise<", @@ -342,13 +336,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/apm/server/routes/typings.ts", @@ -543,13 +531,7 @@ "text": "LicensingApiRequestHandlerContext" }, ">; }, request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => Promise<{ readonly index: string; create: (createParams: { annotation: { type: string; }; '@timestamp': string; message: string; } & { tags?: string[] | undefined; service?: { name?: string | undefined; environment?: string | undefined; version?: string | undefined; } | undefined; }) => Promise<{ _id: string; _index: string; _source: ", "Annotation", "; }>; getById: (getByIdParams: { id: string; }) => Promise<", @@ -5340,13 +5322,7 @@ "description": [], "signature": [ "(params: { debug?: boolean | undefined; request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "; context: ", "ApmPluginRequestHandlerContext", "; }) => Promise<", @@ -5387,13 +5363,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/apm/server/types.ts", diff --git a/api_docs/apm.mdx b/api_docs/apm.mdx index 530350ff2cb0d..1e52586d92225 100644 --- a/api_docs/apm.mdx +++ b/api_docs/apm.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/apm title: "apm" image: https://source.unsplash.com/400x175/?github summary: API docs for the apm plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/banners.mdx b/api_docs/banners.mdx index bbde20ffe2fc2..60a50ae742061 100644 --- a/api_docs/banners.mdx +++ b/api_docs/banners.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/banners title: "banners" image: https://source.unsplash.com/400x175/?github summary: API docs for the banners plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/bfetch.devdocs.json b/api_docs/bfetch.devdocs.json index 418468cf7da1c..a237342580ae8 100644 --- a/api_docs/bfetch.devdocs.json +++ b/api_docs/bfetch.devdocs.json @@ -273,13 +273,7 @@ "description": [], "signature": [ "(path: string, handler: (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", { "pluginId": "bfetch", @@ -316,13 +310,7 @@ "description": [], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", { "pluginId": "bfetch", @@ -349,13 +337,7 @@ "description": [], "signature": [ "(path: string, params: (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", { "pluginId": "bfetch", @@ -392,13 +374,7 @@ "description": [], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", { "pluginId": "bfetch", diff --git a/api_docs/bfetch.mdx b/api_docs/bfetch.mdx index 907f5f2c5df4a..d11bfb0ab67a5 100644 --- a/api_docs/bfetch.mdx +++ b/api_docs/bfetch.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/bfetch title: "bfetch" image: https://source.unsplash.com/400x175/?github summary: API docs for the bfetch plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/canvas.mdx b/api_docs/canvas.mdx index 2b3d2dfffdd4f..e647d472c91f9 100644 --- a/api_docs/canvas.mdx +++ b/api_docs/canvas.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/canvas title: "canvas" image: https://source.unsplash.com/400x175/?github summary: API docs for the canvas plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/cases.devdocs.json b/api_docs/cases.devdocs.json index 19e95e54c71df..9cffcdc9c4385 100644 --- a/api_docs/cases.devdocs.json +++ b/api_docs/cases.devdocs.json @@ -1010,13 +1010,7 @@ ], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => Promise<", { "pluginId": "cases", @@ -1040,13 +1034,7 @@ "a KibanaRequest" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/cases/server/types.ts", diff --git a/api_docs/cases.mdx b/api_docs/cases.mdx index a019a06a5063f..2aa643e48d15b 100644 --- a/api_docs/cases.mdx +++ b/api_docs/cases.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/cases title: "cases" image: https://source.unsplash.com/400x175/?github summary: API docs for the cases plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/charts.mdx b/api_docs/charts.mdx index ea4ce3f409c17..9671ccbe8af2f 100644 --- a/api_docs/charts.mdx +++ b/api_docs/charts.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/charts title: "charts" image: https://source.unsplash.com/400x175/?github summary: API docs for the charts plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/cloud.mdx b/api_docs/cloud.mdx index c431101cb489d..01ec58337accf 100644 --- a/api_docs/cloud.mdx +++ b/api_docs/cloud.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/cloud title: "cloud" image: https://source.unsplash.com/400x175/?github summary: API docs for the cloud plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/cloud_security_posture.mdx b/api_docs/cloud_security_posture.mdx index 883141780077b..21e18763c07cc 100644 --- a/api_docs/cloud_security_posture.mdx +++ b/api_docs/cloud_security_posture.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/cloudSecurityPosture title: "cloudSecurityPosture" image: https://source.unsplash.com/400x175/?github summary: API docs for the cloudSecurityPosture plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/console.mdx b/api_docs/console.mdx index 497825a8cb658..bf2db61245112 100644 --- a/api_docs/console.mdx +++ b/api_docs/console.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/console title: "console" image: https://source.unsplash.com/400x175/?github summary: API docs for the console plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/controls.mdx b/api_docs/controls.mdx index 451a717752ff1..fc1869da56022 100644 --- a/api_docs/controls.mdx +++ b/api_docs/controls.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/controls title: "controls" image: https://source.unsplash.com/400x175/?github summary: API docs for the controls plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/core.devdocs.json b/api_docs/core.devdocs.json index eb878de03826f..04ccf7434c847 100644 --- a/api_docs/core.devdocs.json +++ b/api_docs/core.devdocs.json @@ -1282,13 +1282,7 @@ "{@link HttpSetup}" ], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "src/core/public/index.ts", "deprecated": false @@ -1523,13 +1517,7 @@ "{@link HttpStart}" ], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "src/core/public/index.ts", "deprecated": false @@ -2603,114 +2591,263 @@ }, { "parentPluginId": "core", - "id": "def-public.I18nStart", + "id": "def-public.HttpFetchOptions", "type": "Interface", "tags": [], - "label": "I18nStart", + "label": "HttpFetchOptions", "description": [ - "\nI18nStart.Context is required by any localizable React component from \\@kbn/i18n and \\@elastic/eui packages\nand is supposed to be used as the topmost component for any i18n-compatible React tree.\n" + "\nAll options that may be used with a {@link HttpHandler}." ], - "path": "node_modules/@types/kbn__core-i18n-browser/index.d.ts", + "signature": [ + "HttpFetchOptions", + " extends ", + "HttpRequestInit" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.I18nStart.Context", - "type": "Function", + "id": "def-public.HttpFetchOptions.query", + "type": "Object", "tags": [], - "label": "Context", + "label": "query", "description": [ - "\nReact Context provider required as the topmost component for any i18n-compatible React tree." + "\nThe query string for an HTTP request. See {@link HttpFetchQuery}." ], "signature": [ - "({ children }: { children: React.ReactNode; }) => JSX.Element" + "HttpFetchQuery", + " | undefined" ], - "path": "node_modules/@types/kbn__core-i18n-browser/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.I18nStart.Context.$1", - "type": "Object", - "tags": [], - "label": "{ children }", - "description": [], - "path": "node_modules/@types/kbn__core-i18n-browser/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.I18nStart.Context.$1.children", - "type": "CompoundType", - "tags": [], - "label": "children", - "description": [], - "signature": [ - "boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined" - ], - "path": "node_modules/@types/kbn__core-i18n-browser/index.d.ts", - "deprecated": false - } - ] - } + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpFetchOptions.prependBasePath", + "type": "CompoundType", + "tags": [], + "label": "prependBasePath", + "description": [ + "\nWhether or not the request should automatically prepend the basePath. Defaults to `true`." ], - "returnComment": [] + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpFetchOptions.headers", + "type": "Object", + "tags": [], + "label": "headers", + "description": [ + "\nHeaders to send with the request. See {@link HttpHeadersInit}." + ], + "signature": [ + "HttpHeadersInit", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpFetchOptions.asSystemRequest", + "type": "CompoundType", + "tags": [], + "label": "asSystemRequest", + "description": [ + "\nWhether or not the request should include the \"system request\" header to differentiate an end user request from\nKibana internal request.\nCan be read on the server-side using KibanaRequest#isSystemRequest. Defaults to `false`." + ], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpFetchOptions.asResponse", + "type": "CompoundType", + "tags": [], + "label": "asResponse", + "description": [ + "\nWhen `true` the return type of {@link HttpHandler} will be an {@link HttpResponse} with detailed request and\nresponse information. When `false`, the return type will just be the parsed response body. Defaults to `false`." + ], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpFetchOptions.context", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "KibanaExecutionContext", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.IExternalUrlPolicy", + "id": "def-public.HttpFetchOptionsWithPath", "type": "Interface", "tags": [], - "label": "IExternalUrlPolicy", + "label": "HttpFetchOptionsWithPath", "description": [ - "\nA policy describing whether access to an external destination is allowed." + "\nSimilar to {@link HttpFetchOptions} but with the URL path included." + ], + "signature": [ + "HttpFetchOptionsWithPath", + " extends ", + "HttpFetchOptions" ], - "path": "src/core/server/http/external_url/external_url_config.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.IExternalUrlPolicy.allow", - "type": "boolean", + "id": "def-public.HttpFetchOptionsWithPath.path", + "type": "string", "tags": [], - "label": "allow", + "label": "path", + "description": [], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpFetchQuery", + "type": "Interface", + "tags": [], + "label": "HttpFetchQuery", + "description": [], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.HttpFetchQuery.Unnamed", + "type": "IndexSignature", + "tags": [], + "label": "[key: string]: string | number | boolean | string[] | number[] | boolean[] | null | undefined", "description": [ - "\nIndicates if this policy allows or denies access to the described destination." + "\nTypeScript note: Technically we should use this interface instead, but @types/node uses the below stricter\ndefinition, so to avoid TypeScript errors, we'll restrict our version.\n\n[key: string]:\n | string\n | number\n | boolean\n | Array\n | undefined\n | null;" + ], + "signature": [ + "[key: string]: string | number | boolean | string[] | number[] | boolean[] | null | undefined" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpHandler", + "type": "Interface", + "tags": [], + "label": "HttpHandler", + "description": [ + "\nA function for making an HTTP requests to Kibana's backend. See {@link HttpFetchOptions} for options and\n{@link HttpResponse} for the response.\n" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.HttpHandler.Unnamed", + "type": "Any", + "tags": [], + "label": "Unnamed", + "description": [], + "signature": [ + "any" ], - "path": "src/core/server/http/external_url/external_url_config.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.IExternalUrlPolicy.host", - "type": "string", + "id": "def-public.HttpHandler.Unnamed", + "type": "Any", "tags": [], - "label": "host", - "description": [ - "\nOptional host describing the external destination.\nMay be combined with `protocol`.\n" + "label": "Unnamed", + "description": [], + "signature": [ + "any" ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpHandler.Unnamed", + "type": "Any", + "tags": [], + "label": "Unnamed", + "description": [], "signature": [ - "string | undefined" + "any" ], - "path": "src/core/server/http/external_url/external_url_config.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.IExternalUrlPolicy.protocol", - "type": "string", + "id": "def-public.HttpHandler.Unnamed", + "type": "Any", "tags": [], - "label": "protocol", - "description": [ - "\nOptional protocol describing the external destination.\nMay be combined with `host`.\n" + "label": "Unnamed", + "description": [], + "signature": [ + "any" ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpHeadersInit", + "type": "Interface", + "tags": [], + "label": "HttpHeadersInit", + "description": [ + "\nHeaders to append to the request. Any headers that begin with `kbn-` are considered private to Core and will cause\n{@link HttpHandler} to throw an error." + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.HttpHeadersInit.Unnamed", + "type": "IndexSignature", + "tags": [], + "label": "[name: string]: any", + "description": [], "signature": [ - "string | undefined" + "[name: string]: any" ], - "path": "src/core/server/http/external_url/external_url_config.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false } ], @@ -2718,47 +2855,68 @@ }, { "parentPluginId": "core", - "id": "def-public.IShipper", + "id": "def-public.HttpInterceptor", "type": "Interface", "tags": [], - "label": "IShipper", + "label": "HttpInterceptor", "description": [ - "\nBasic structure of a Shipper" + "\nAn object that may define global interceptor functions for different parts of the request and response lifecycle.\nSee {@link IHttpInterceptController}.\n" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.IShipper.reportEvents", + "id": "def-public.HttpInterceptor.request", "type": "Function", "tags": [], - "label": "reportEvents", + "label": "request", "description": [ - "\nAdapts and ships the event to the persisting/analytics solution." + "\nDefine an interceptor to be executed before a request is sent." ], "signature": [ - "(events: ", - "Event", - "[]) => void" + "((fetchOptions: Readonly<", + "HttpFetchOptionsWithPath", + ">, controller: ", + "IHttpInterceptController", + ") => void | ", + "MaybePromise", + ">) | undefined" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.IShipper.reportEvents.$1", - "type": "Array", + "id": "def-public.HttpInterceptor.request.$1", + "type": "Object", "tags": [], - "label": "events", + "label": "fetchOptions", + "description": [], + "signature": [ + "Readonly<", + "HttpFetchOptionsWithPath", + ">" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.HttpInterceptor.request.$2", + "type": "Object", + "tags": [], + "label": "controller", "description": [ - "batched events {@link Event }" + "{@link IHttpInterceptController }" ], "signature": [ - "Event", - "[]" + "IHttpInterceptController" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "isRequired": true } @@ -2767,68 +2925,56 @@ }, { "parentPluginId": "core", - "id": "def-public.IShipper.optIn", + "id": "def-public.HttpInterceptor.requestError", "type": "Function", "tags": [], - "label": "optIn", + "label": "requestError", "description": [ - "\nStops/restarts the shipping mechanism based on the value of isOptedIn" + "\nDefine an interceptor to be executed if a request interceptor throws an error or returns a rejected Promise." ], "signature": [ - "(isOptedIn: boolean) => void" + "((httpErrorRequest: ", + "HttpInterceptorRequestError", + ", controller: ", + "IHttpInterceptController", + ") => void | ", + "MaybePromise", + ">) | undefined" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.IShipper.optIn.$1", - "type": "boolean", + "id": "def-public.HttpInterceptor.requestError.$1", + "type": "Object", "tags": [], - "label": "isOptedIn", + "label": "httpErrorRequest", "description": [ - "`true` for resume sending events. `false` to stop." + "{@link HttpInterceptorRequestError }" ], "signature": [ - "boolean" + "HttpInterceptorRequestError" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-public.IShipper.extendContext", - "type": "Function", - "tags": [], - "label": "extendContext", - "description": [ - "\nPerform any necessary calls to the persisting/analytics solution to set the event's context." - ], - "signature": [ - "((newContext: ", - "EventContext", - ") => void) | undefined" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-public.IShipper.extendContext.$1", + "id": "def-public.HttpInterceptor.requestError.$2", "type": "Object", "tags": [], - "label": "newContext", + "label": "controller", "description": [ - "The full new context to set {@link EventContext }" + "{@link IHttpInterceptController }" ], "signature": [ - "EventContext" + "IHttpInterceptController" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "isRequired": true } @@ -2837,585 +2983,505 @@ }, { "parentPluginId": "core", - "id": "def-public.IShipper.telemetryCounter$", - "type": "Object", - "tags": [], - "label": "telemetryCounter$", - "description": [ - "\nObservable to emit the stats of the processed events." - ], - "signature": [ - "Observable", - "<", - "TelemetryCounter", - "> | undefined" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.IShipper.shutdown", - "type": "Function", - "tags": [], - "label": "shutdown", - "description": [ - "\nShutdown the shipper." - ], - "signature": [ - "() => void" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.IUiSettingsClient", - "type": "Interface", - "tags": [], - "label": "IUiSettingsClient", - "description": [ - "\nClient-side client that provides access to the advanced settings stored in elasticsearch.\nThe settings provide control over the behavior of the Kibana application.\nFor example, a user can specify how to display numeric or date fields.\nUsers can adjust the settings via Management UI.\n{@link IUiSettingsClient}\n" - ], - "path": "src/core/public/ui_settings/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.get", + "id": "def-public.HttpInterceptor.response", "type": "Function", "tags": [], - "label": "get", + "label": "response", "description": [ - "\nGets the value for a specific uiSetting. If this setting has no user-defined value\nthen the `defaultOverride` parameter is returned (and parsed if setting is of type\n\"json\" or \"number). If the parameter is not defined and the key is not registered\nby any plugin then an error is thrown, otherwise reads the default value defined by a plugin." + "\nDefine an interceptor to be executed after a response is received." ], "signature": [ - "(key: string, defaultOverride?: T | undefined) => T" + "((httpResponse: ", + "HttpResponse", + ", controller: ", + "IHttpInterceptController", + ") => void | ", + "MaybePromise", + "<", + "IHttpResponseInterceptorOverrides", + ">) | undefined" ], - "path": "src/core/public/ui_settings/types.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.get.$1", - "type": "string", + "id": "def-public.HttpInterceptor.response.$1", + "type": "Object", "tags": [], - "label": "key", - "description": [], + "label": "httpResponse", + "description": [ + "{@link HttpResponse }" + ], "signature": [ - "string" + "HttpResponse", + "" ], - "path": "src/core/public/ui_settings/types.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.get.$2", - "type": "Uncategorized", + "id": "def-public.HttpInterceptor.response.$2", + "type": "Object", "tags": [], - "label": "defaultOverride", - "description": [], + "label": "controller", + "description": [ + "{@link IHttpInterceptController }" + ], "signature": [ - "T | undefined" + "IHttpInterceptController" ], - "path": "src/core/public/ui_settings/types.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.get$", + "id": "def-public.HttpInterceptor.responseError", "type": "Function", "tags": [], - "label": "get$", + "label": "responseError", "description": [ - "\nGets an observable of the current value for a config key, and all updates to that config\nkey in the future. Providing a `defaultOverride` argument behaves the same as it does in #get()" + "\nDefine an interceptor to be executed if a response interceptor throws an error or returns a rejected Promise." ], "signature": [ - "(key: string, defaultOverride?: T | undefined) => ", - "Observable", - "" + "((httpErrorResponse: ", + "HttpInterceptorResponseError", + ", controller: ", + "IHttpInterceptController", + ") => void | ", + "MaybePromise", + "<", + "IHttpResponseInterceptorOverrides", + ">) | undefined" ], - "path": "src/core/public/ui_settings/types.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.get$.$1", - "type": "string", + "id": "def-public.HttpInterceptor.responseError.$1", + "type": "Object", "tags": [], - "label": "key", - "description": [], + "label": "httpErrorResponse", + "description": [ + "{@link HttpInterceptorResponseError }" + ], "signature": [ - "string" + "HttpInterceptorResponseError" ], - "path": "src/core/public/ui_settings/types.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.get$.$2", - "type": "Uncategorized", + "id": "def-public.HttpInterceptor.responseError.$2", + "type": "Object", "tags": [], - "label": "defaultOverride", - "description": [], + "label": "controller", + "description": [ + "{@link IHttpInterceptController }" + ], "signature": [ - "T | undefined" + "IHttpInterceptController" ], - "path": "src/core/public/ui_settings/types.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpInterceptorRequestError", + "type": "Interface", + "tags": [], + "label": "HttpInterceptorRequestError", + "description": [], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.HttpInterceptorRequestError.fetchOptions", + "type": "Object", + "tags": [], + "label": "fetchOptions", + "description": [], + "signature": [ + "{ readonly path: string; readonly query?: ", + "HttpFetchQuery", + " | undefined; readonly prependBasePath?: boolean | undefined; readonly headers?: ", + "HttpHeadersInit", + " | undefined; readonly asSystemRequest?: boolean | undefined; readonly asResponse?: boolean | undefined; readonly context?: ", + "KibanaExecutionContext", + " | undefined; readonly body?: BodyInit | null | undefined; readonly cache?: RequestCache | undefined; readonly credentials?: RequestCredentials | undefined; readonly integrity?: string | undefined; readonly keepalive?: boolean | undefined; readonly method?: string | undefined; readonly mode?: RequestMode | undefined; readonly redirect?: RequestRedirect | undefined; readonly referrer?: string | undefined; readonly referrerPolicy?: ReferrerPolicy | undefined; readonly signal?: AbortSignal | null | undefined; readonly window?: null | undefined; }" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.getAll", - "type": "Function", + "id": "def-public.HttpInterceptorRequestError.error", + "type": "Object", "tags": [], - "label": "getAll", - "description": [ - "\nGets the metadata about all uiSettings, including the type, default value, and user value\nfor each key." + "label": "error", + "description": [], + "signature": [ + "Error" ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpInterceptorResponseError", + "type": "Interface", + "tags": [], + "label": "HttpInterceptorResponseError", + "description": [], + "signature": [ + "HttpInterceptorResponseError", + " extends ", + "HttpResponse", + "" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.HttpInterceptorResponseError.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [], "signature": [ - "() => Readonly>>" + "{ readonly cache: RequestCache; readonly credentials: RequestCredentials; readonly destination: RequestDestination; readonly headers: Headers; readonly integrity: string; readonly keepalive: boolean; readonly method: string; readonly mode: RequestMode; readonly redirect: RequestRedirect; readonly referrer: string; readonly referrerPolicy: ReferrerPolicy; readonly signal: AbortSignal; readonly url: string; readonly clone: () => Request; readonly body: ReadableStream | null; readonly bodyUsed: boolean; readonly arrayBuffer: () => Promise; readonly blob: () => Promise; readonly formData: () => Promise; readonly json: () => Promise; readonly text: () => Promise; }" ], - "path": "src/core/public/ui_settings/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.set", - "type": "Function", + "id": "def-public.HttpInterceptorResponseError.error", + "type": "CompoundType", "tags": [], - "label": "set", + "label": "error", + "description": [], + "signature": [ + "Error | ", + "IHttpFetchError", + "" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpRequestInit", + "type": "Interface", + "tags": [], + "label": "HttpRequestInit", + "description": [ + "\nFetch API options available to {@link HttpHandler}s.\n" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.HttpRequestInit.body", + "type": "CompoundType", + "tags": [], + "label": "body", "description": [ - "\nSets the value for a uiSetting. If the setting is not registered by any plugin\nit will be stored as a custom setting. The new value will be synchronously available via\nthe `get()` method and sent to the server in the background. If the request to the\nserver fails then a updateErrors$ will be notified and the setting will be\nreverted to its value before `set()` was called." + "\nA BodyInit object or null to set request's body." ], "signature": [ - "(key: string, value: any) => Promise" - ], - "path": "src/core/public/ui_settings/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.set.$1", - "type": "string", - "tags": [], - "label": "key", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/public/ui_settings/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.set.$2", - "type": "Any", - "tags": [], - "label": "value", - "description": [], - "signature": [ - "any" - ], - "path": "src/core/public/ui_settings/types.ts", - "deprecated": false, - "isRequired": true - } + "BodyInit | null | undefined" ], - "returnComment": [] + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.remove", - "type": "Function", + "id": "def-public.HttpRequestInit.cache", + "type": "CompoundType", "tags": [], - "label": "remove", + "label": "cache", "description": [ - "\nRemoves the user-defined value for a setting, causing it to revert to the default. This\nmethod behaves the same as calling `set(key, null)`, including the synchronization, custom\nsetting, and error behavior of that method." + "\nThe cache mode associated with request, which is a string indicating how the request will interact with the\nbrowser's cache when fetching." ], "signature": [ - "(key: string) => Promise" + "RequestCache | undefined" ], - "path": "src/core/public/ui_settings/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.remove.$1", - "type": "string", - "tags": [], - "label": "key", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/public/ui_settings/types.ts", - "deprecated": false, - "isRequired": true - } + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpRequestInit.credentials", + "type": "CompoundType", + "tags": [], + "label": "credentials", + "description": [ + "\nThe credentials mode associated with request, which is a string indicating whether credentials will be sent with\nthe request always, never, or only when sent to a same-origin URL." ], - "returnComment": [] + "signature": [ + "RequestCredentials | undefined" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.isDeclared", - "type": "Function", + "id": "def-public.HttpRequestInit.headers", + "type": "Object", "tags": [], - "label": "isDeclared", + "label": "headers", "description": [ - "\nReturns true if the key is a \"known\" uiSetting, meaning it is either registered\nby any plugin or was previously added as a custom setting via the `set()` method." + "{@link HttpHeadersInit}" ], "signature": [ - "(key: string) => boolean" + "HttpHeadersInit", + " | undefined" ], - "path": "src/core/public/ui_settings/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.isDeclared.$1", - "type": "string", - "tags": [], - "label": "key", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/public/ui_settings/types.ts", - "deprecated": false, - "isRequired": true - } + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpRequestInit.integrity", + "type": "string", + "tags": [], + "label": "integrity", + "description": [ + "\nSubresource integrity metadata, which is a cryptographic hash of the resource being fetched. Its value consists of\nmultiple hashes separated by whitespace." ], - "returnComment": [] + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.isDefault", - "type": "Function", + "id": "def-public.HttpRequestInit.keepalive", + "type": "CompoundType", "tags": [], - "label": "isDefault", + "label": "keepalive", "description": [ - "\nReturns true if the setting has no user-defined value or is unknown" + "Whether or not request can outlive the global in which it was created." ], "signature": [ - "(key: string) => boolean" + "boolean | undefined" ], - "path": "src/core/public/ui_settings/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.isDefault.$1", - "type": "string", - "tags": [], - "label": "key", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/public/ui_settings/types.ts", - "deprecated": false, - "isRequired": true - } + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpRequestInit.method", + "type": "string", + "tags": [], + "label": "method", + "description": [ + "HTTP method, which is \"GET\" by default." ], - "returnComment": [] + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.isCustom", - "type": "Function", + "id": "def-public.HttpRequestInit.mode", + "type": "CompoundType", "tags": [], - "label": "isCustom", + "label": "mode", "description": [ - "\nReturns true if the setting wasn't registered by any plugin, but was either\nadded directly via `set()`, or is an unknown setting found in the uiSettings saved\nobject" + "\nThe mode associated with request, which is a string indicating whether the request will use CORS, or will be\nrestricted to same-origin URLs." ], "signature": [ - "(key: string) => boolean" + "RequestMode | undefined" ], - "path": "src/core/public/ui_settings/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.isCustom.$1", - "type": "string", - "tags": [], - "label": "key", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/public/ui_settings/types.ts", - "deprecated": false, - "isRequired": true - } + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpRequestInit.redirect", + "type": "CompoundType", + "tags": [], + "label": "redirect", + "description": [ + "\nThe redirect mode associated with request, which is a string indicating how redirects for the request will be\nhandled during fetching. A request will follow redirects by default." ], - "returnComment": [] + "signature": [ + "RequestRedirect | undefined" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.isOverridden", - "type": "Function", + "id": "def-public.HttpRequestInit.referrer", + "type": "string", "tags": [], - "label": "isOverridden", + "label": "referrer", "description": [ - "\nShows whether the uiSettings value set by the user." + "\nThe referrer of request. Its value can be a same-origin URL if explicitly set in init, the empty string to\nindicate no referrer, and \"about:client\" when defaulting to the global's default. This is used during fetching to\ndetermine the value of the `Referer` header of the request being made." ], "signature": [ - "(key: string) => boolean" + "string | undefined" ], - "path": "src/core/public/ui_settings/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.isOverridden.$1", - "type": "string", - "tags": [], - "label": "key", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/public/ui_settings/types.ts", - "deprecated": false, - "isRequired": true - } + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpRequestInit.referrerPolicy", + "type": "CompoundType", + "tags": [], + "label": "referrerPolicy", + "description": [ + "\nThe referrer policy associated with request. This is used during fetching to compute the value of the request's\nreferrer." ], - "returnComment": [] + "signature": [ + "ReferrerPolicy | undefined" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.getUpdate$", - "type": "Function", + "id": "def-public.HttpRequestInit.signal", + "type": "CompoundType", "tags": [], - "label": "getUpdate$", + "label": "signal", "description": [ - "\nReturns an Observable that notifies subscribers of each update to the uiSettings,\nincluding the key, newValue, and oldValue of the setting that changed." + "\nReturns the signal associated with request, which is an AbortSignal object indicating whether or not request has\nbeen aborted, and its abort event handler." ], "signature": [ - "() => ", - "Observable", - "<{ key: string; newValue: T; oldValue: T; }>" + "AbortSignal | null | undefined" ], - "path": "src/core/public/ui_settings/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.getUpdateErrors$", - "type": "Function", + "id": "def-public.HttpRequestInit.window", + "type": "Uncategorized", "tags": [], - "label": "getUpdateErrors$", + "label": "window", "description": [ - "\nReturns an Observable that notifies subscribers of each error while trying to update\nthe settings, containing the actual Error class." + "\nCan only be null. Used to disassociate request from any Window." ], "signature": [ - "() => ", - "Observable", - "" + "null | undefined" ], - "path": "src/core/public/ui_settings/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.NotificationsSetup", + "id": "def-public.HttpResponse", "type": "Interface", "tags": [], - "label": "NotificationsSetup", + "label": "HttpResponse", "description": [], - "path": "src/core/public/notifications/notifications_service.ts", + "signature": [ + "HttpResponse", + "" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.NotificationsSetup.toasts", + "id": "def-public.HttpResponse.fetchOptions", "type": "Object", "tags": [], - "label": "toasts", + "label": "fetchOptions", "description": [ - "{@link ToastsSetup}" + "The original {@link HttpFetchOptionsWithPath} used to send this request." ], "signature": [ - "{ add: (toastOrTitle: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" - }, - ") => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; get$: () => ", - "Observable", - "<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "[]>; remove: (toastOrId: string | ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - ") => void; addSuccess: (toastOrTitle: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastOptions", - "text": "ToastOptions" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; addWarning: (toastOrTitle: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastOptions", - "text": "ToastOptions" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; addDanger: (toastOrTitle: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastOptions", - "text": "ToastOptions" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; addError: (error: Error, options: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ErrorToastOptions", - "text": "ErrorToastOptions" - }, - ") => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; addInfo: (toastOrTitle: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastOptions", - "text": "ToastOptions" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; }" + "{ readonly path: string; readonly query?: ", + "HttpFetchQuery", + " | undefined; readonly prependBasePath?: boolean | undefined; readonly headers?: ", + "HttpHeadersInit", + " | undefined; readonly asSystemRequest?: boolean | undefined; readonly asResponse?: boolean | undefined; readonly context?: ", + "KibanaExecutionContext", + " | undefined; readonly body?: BodyInit | null | undefined; readonly cache?: RequestCache | undefined; readonly credentials?: RequestCredentials | undefined; readonly integrity?: string | undefined; readonly keepalive?: boolean | undefined; readonly method?: string | undefined; readonly mode?: RequestMode | undefined; readonly redirect?: RequestRedirect | undefined; readonly referrer?: string | undefined; readonly referrerPolicy?: ReferrerPolicy | undefined; readonly signal?: AbortSignal | null | undefined; readonly window?: null | undefined; }" ], - "path": "src/core/public/notifications/notifications_service.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpResponse.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [ + "Raw request sent to Kibana server." + ], + "signature": [ + "{ readonly cache: RequestCache; readonly credentials: RequestCredentials; readonly destination: RequestDestination; readonly headers: Headers; readonly integrity: string; readonly keepalive: boolean; readonly method: string; readonly mode: RequestMode; readonly redirect: RequestRedirect; readonly referrer: string; readonly referrerPolicy: ReferrerPolicy; readonly signal: AbortSignal; readonly url: string; readonly clone: () => Request; readonly body: ReadableStream | null; readonly bodyUsed: boolean; readonly arrayBuffer: () => Promise; readonly blob: () => Promise; readonly formData: () => Promise; readonly json: () => Promise; readonly text: () => Promise; }" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpResponse.response", + "type": "Object", + "tags": [], + "label": "response", + "description": [ + "Raw response received, may be undefined if there was an error." + ], + "signature": [ + "Readonly | undefined" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpResponse.body", + "type": "Uncategorized", + "tags": [], + "label": "body", + "description": [ + "Parsed body received, may be undefined if there was an error." + ], + "signature": [ + "TResponseBody | undefined" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false } ], @@ -3423,434 +3489,406 @@ }, { "parentPluginId": "core", - "id": "def-public.NotificationsStart", + "id": "def-public.HttpSetup", "type": "Interface", "tags": [], - "label": "NotificationsStart", + "label": "HttpSetup", "description": [], - "path": "src/core/public/notifications/notifications_service.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.NotificationsStart.toasts", + "id": "def-public.HttpSetup.basePath", "type": "Object", "tags": [], - "label": "toasts", + "label": "basePath", "description": [ - "{@link ToastsStart}" + "\nAPIs for manipulating the basePath on URL segments.\nSee {@link IBasePath}" ], "signature": [ - "{ add: (toastOrTitle: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" - }, - ") => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; get$: () => ", - "Observable", - "<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "[]>; remove: (toastOrId: string | ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - ") => void; addSuccess: (toastOrTitle: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastOptions", - "text": "ToastOptions" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; addWarning: (toastOrTitle: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastOptions", - "text": "ToastOptions" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; addDanger: (toastOrTitle: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" - }, - ", options?: ", + "IBasePath" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpSetup.anonymousPaths", + "type": "Object", + "tags": [], + "label": "anonymousPaths", + "description": [ + "\nAPIs for denoting certain paths for not requiring authentication" + ], + "signature": [ + "IAnonymousPaths" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpSetup.externalUrl", + "type": "Object", + "tags": [], + "label": "externalUrl", + "description": [], + "signature": [ + "IExternalUrl" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpSetup.intercept", + "type": "Function", + "tags": [], + "label": "intercept", + "description": [ + "\nAdds a new {@link HttpInterceptor} to the global HTTP client." + ], + "signature": [ + "(interceptor: ", + "HttpInterceptor", + ") => () => void" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastOptions", - "text": "ToastOptions" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; addError: (error: Error, options: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ErrorToastOptions", - "text": "ErrorToastOptions" - }, - ") => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; addInfo: (toastOrTitle: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastOptions", - "text": "ToastOptions" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; }" + "parentPluginId": "core", + "id": "def-public.HttpSetup.intercept.$1", + "type": "Object", + "tags": [], + "label": "interceptor", + "description": [ + "a {@link HttpInterceptor }" + ], + "signature": [ + "HttpInterceptor" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "src/core/public/notifications/notifications_service.ts", + "returnComment": [ + "a function for removing the attached interceptor." + ] + }, + { + "parentPluginId": "core", + "id": "def-public.HttpSetup.fetch", + "type": "Function", + "tags": [], + "label": "fetch", + "description": [ + "Makes an HTTP request. Defaults to a GET request unless overridden. See {@link HttpHandler} for options." + ], + "signature": [ + "HttpHandler" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.OptInConfig", - "type": "Interface", - "tags": [], - "label": "OptInConfig", - "description": [ - "\n" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-public.OptInConfig.global", - "type": "Object", + "id": "def-public.HttpSetup.delete", + "type": "Function", "tags": [], - "label": "global", + "label": "delete", "description": [ - "\nControls the global enabled/disabled behaviour of the client and shippers." + "Makes an HTTP request with the DELETE method. See {@link HttpHandler} for options." ], "signature": [ - "OptInConfigPerType" + "HttpHandler" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.OptInConfig.event_types", - "type": "Object", + "id": "def-public.HttpSetup.get", + "type": "Function", "tags": [], - "label": "event_types", + "label": "get", "description": [ - "\nControls if an event type should be disabled for a specific type of shipper." + "Makes an HTTP request with the GET method. See {@link HttpHandler} for options." ], "signature": [ - "Record | undefined" + "HttpHandler" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.OverlayBannersStart", - "type": "Interface", - "tags": [], - "label": "OverlayBannersStart", - "description": [], - "path": "src/core/public/overlays/banners/banners_service.tsx", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-public.OverlayBannersStart.add", + "id": "def-public.HttpSetup.head", "type": "Function", "tags": [], - "label": "add", + "label": "head", "description": [ - "\nAdd a new banner\n" + "Makes an HTTP request with the HEAD method. See {@link HttpHandler} for options." ], "signature": [ - "(mount: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - ", priority?: number | undefined) => string" + "HttpHandler" ], - "path": "src/core/public/overlays/banners/banners_service.tsx", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.OverlayBannersStart.add.$1", - "type": "Function", - "tags": [], - "label": "mount", - "description": [ - "{@link MountPoint }" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - "" - ], - "path": "src/core/public/overlays/banners/banners_service.tsx", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-public.OverlayBannersStart.add.$2", - "type": "number", - "tags": [], - "label": "priority", - "description": [ - "optional priority order to display this banner. Higher priority values are shown first." - ], - "signature": [ - "number | undefined" - ], - "path": "src/core/public/overlays/banners/banners_service.tsx", - "deprecated": false, - "isRequired": false - } + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpSetup.options", + "type": "Function", + "tags": [], + "label": "options", + "description": [ + "Makes an HTTP request with the OPTIONS method. See {@link HttpHandler} for options." ], - "returnComment": [ - "a unique identifier for the given banner to be used with {@link OverlayBannersStart.remove } and\n{@link OverlayBannersStart.replace }" - ] + "signature": [ + "HttpHandler" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.OverlayBannersStart.remove", + "id": "def-public.HttpSetup.patch", "type": "Function", "tags": [], - "label": "remove", + "label": "patch", "description": [ - "\nRemove a banner\n" + "Makes an HTTP request with the PATCH method. See {@link HttpHandler} for options." ], "signature": [ - "(id: string) => boolean" + "HttpHandler" ], - "path": "src/core/public/overlays/banners/banners_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpSetup.post", + "type": "Function", + "tags": [], + "label": "post", + "description": [ + "Makes an HTTP request with the POST method. See {@link HttpHandler} for options." + ], + "signature": [ + "HttpHandler" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpSetup.put", + "type": "Function", + "tags": [], + "label": "put", + "description": [ + "Makes an HTTP request with the PUT method. See {@link HttpHandler} for options." + ], + "signature": [ + "HttpHandler" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpSetup.addLoadingCountSource", + "type": "Function", + "tags": [], + "label": "addLoadingCountSource", + "description": [ + "\nAdds a new source of loading counts. Used to show the global loading indicator when sum of all observed counts are\nmore than 0." + ], + "signature": [ + "(countSource$: ", + "Observable", + ") => void" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.OverlayBannersStart.remove.$1", - "type": "string", + "id": "def-public.HttpSetup.addLoadingCountSource.$1", + "type": "Object", "tags": [], - "label": "id", + "label": "countSource$", "description": [ - "the unique identifier for the banner returned by {@link OverlayBannersStart.add }" + "an Observable to subscribe to for loading count updates." ], "signature": [ - "string" + "Observable", + "" ], - "path": "src/core/public/overlays/banners/banners_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [ - "if the banner was found or not" - ] + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.OverlayBannersStart.replace", + "id": "def-public.HttpSetup.getLoadingCount$", "type": "Function", "tags": [], - "label": "replace", + "label": "getLoadingCount$", "description": [ - "\nReplace a banner in place\n" + "\nGet the sum of all loading count sources as a single Observable." ], "signature": [ - "(id: string | undefined, mount: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - ", priority?: number | undefined) => string" + "() => ", + "Observable", + "" ], - "path": "src/core/public/overlays/banners/banners_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, - "children": [ + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.I18nStart", + "type": "Interface", + "tags": [], + "label": "I18nStart", + "description": [ + "\nI18nStart.Context is required by any localizable React component from \\@kbn/i18n and \\@elastic/eui packages\nand is supposed to be used as the topmost component for any i18n-compatible React tree.\n" + ], + "path": "node_modules/@types/kbn__core-i18n-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.I18nStart.Context", + "type": "Function", + "tags": [], + "label": "Context", + "description": [ + "\nReact Context provider required as the topmost component for any i18n-compatible React tree." + ], + "signature": [ + "({ children }: { children: React.ReactNode; }) => JSX.Element" + ], + "path": "node_modules/@types/kbn__core-i18n-browser/index.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-public.OverlayBannersStart.replace.$1", - "type": "string", + "id": "def-public.I18nStart.Context.$1", + "type": "Object", "tags": [], - "label": "id", - "description": [ - "the unique identifier for the banner returned by {@link OverlayBannersStart.add }" - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/public/overlays/banners/banners_service.tsx", + "label": "{ children }", + "description": [], + "path": "node_modules/@types/kbn__core-i18n-browser/index.d.ts", "deprecated": false, - "isRequired": false - }, - { - "parentPluginId": "core", - "id": "def-public.OverlayBannersStart.replace.$2", - "type": "Function", - "tags": [], - "label": "mount", - "description": [ - "{@link MountPoint }" - ], - "signature": [ + "children": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - "" - ], - "path": "src/core/public/overlays/banners/banners_service.tsx", - "deprecated": false, - "isRequired": true - }, + "parentPluginId": "core", + "id": "def-public.I18nStart.Context.$1.children", + "type": "CompoundType", + "tags": [], + "label": "children", + "description": [], + "signature": [ + "boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined" + ], + "path": "node_modules/@types/kbn__core-i18n-browser/index.d.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.IAnonymousPaths", + "type": "Interface", + "tags": [], + "label": "IAnonymousPaths", + "description": [ + "\nAPIs for denoting paths as not requiring authentication" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.IAnonymousPaths.isAnonymous", + "type": "Function", + "tags": [], + "label": "isAnonymous", + "description": [ + "\nDetermines whether the provided path doesn't require authentication. `path` should include the current basePath." + ], + "signature": [ + "(path: string) => boolean" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-public.OverlayBannersStart.replace.$3", - "type": "number", + "id": "def-public.IAnonymousPaths.isAnonymous.$1", + "type": "string", "tags": [], - "label": "priority", - "description": [ - "optional priority order to display this banner. Higher priority values are shown first." - ], + "label": "path", + "description": [], "signature": [ - "number | undefined" + "string" ], - "path": "src/core/public/overlays/banners/banners_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], - "returnComment": [ - "a new identifier for the given banner to be used with {@link OverlayBannersStart.remove } and\n{@link OverlayBannersStart.replace }" - ] + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.OverlayBannersStart.getComponent", + "id": "def-public.IAnonymousPaths.register", "type": "Function", "tags": [], - "label": "getComponent", - "description": [], + "label": "register", + "description": [ + "\nRegister `path` as not requiring authentication. `path` should not include the current basePath." + ], "signature": [ - "() => JSX.Element" + "(path: string) => void" ], - "path": "src/core/public/overlays/banners/banners_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, - "children": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.IAnonymousPaths.register.$1", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] } ], @@ -3858,291 +3896,199 @@ }, { "parentPluginId": "core", - "id": "def-public.OverlayFlyoutOpenOptions", + "id": "def-public.IBasePath", "type": "Interface", "tags": [], - "label": "OverlayFlyoutOpenOptions", - "description": [], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "label": "IBasePath", + "description": [ + "\nAPIs for manipulating the basePath on URL segments." + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.OverlayFlyoutOpenOptions.className", - "type": "string", + "id": "def-public.IBasePath.get", + "type": "Function", "tags": [], - "label": "className", - "description": [], + "label": "get", + "description": [ + "\nGets the `basePath` string." + ], "signature": [ - "string | undefined" + "() => string" ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", - "deprecated": false + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.OverlayFlyoutOpenOptions.closeButtonAriaLabel", - "type": "string", + "id": "def-public.IBasePath.prepend", + "type": "Function", "tags": [], - "label": "closeButtonAriaLabel", - "description": [], + "label": "prepend", + "description": [ + "\nPrepends `path` with the basePath." + ], "signature": [ - "string | undefined" + "(url: string) => string" ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", - "deprecated": false + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.IBasePath.prepend.$1", + "type": "string", + "tags": [], + "label": "url", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.OverlayFlyoutOpenOptions.ownFocus", - "type": "CompoundType", + "id": "def-public.IBasePath.remove", + "type": "Function", "tags": [], - "label": "ownFocus", - "description": [], + "label": "remove", + "description": [ + "\nRemoves the prepended basePath from the `path`." + ], "signature": [ - "boolean | undefined" + "(url: string) => string" ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", - "deprecated": false + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.IBasePath.remove.$1", + "type": "string", + "tags": [], + "label": "url", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.OverlayFlyoutOpenOptions.datatestsubj", + "id": "def-public.IBasePath.serverBasePath", "type": "string", "tags": [], - "label": "'data-test-subj'", - "description": [], - "signature": [ - "string | undefined" + "label": "serverBasePath", + "description": [ + "\nReturns the server's root basePath as configured, without any namespace prefix.\n\nSee {@link BasePath.get} for getting the basePath value for a specific request" ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.OverlayFlyoutOpenOptions.arialabel", + "id": "def-public.IBasePath.publicBaseUrl", "type": "string", "tags": [], - "label": "'aria-label'", - "description": [], + "label": "publicBaseUrl", + "description": [ + "\nThe server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the\n{@link IBasePath.serverBasePath}.\n" + ], "signature": [ "string | undefined" ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.IExternalUrl", + "type": "Interface", + "tags": [], + "label": "IExternalUrl", + "description": [ + "\nAPIs for working with external URLs.\n" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-public.OverlayFlyoutOpenOptions.size", - "type": "CompoundType", + "id": "def-public.IExternalUrl.isInternalUrl", + "type": "Function", "tags": [], - "label": "size", - "description": [], + "label": "isInternalUrl", + "description": [ + "\nDetermines if the provided URL is an internal url.\n" + ], "signature": [ - "\"m\" | \"s\" | \"l\" | undefined" + "(relativeOrAbsoluteUrl: string) => boolean" ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.OverlayFlyoutOpenOptions.maxWidth", - "type": "CompoundType", - "tags": [], - "label": "maxWidth", - "description": [], - "signature": [ - "string | number | boolean | undefined" - ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.OverlayFlyoutOpenOptions.hideCloseButton", - "type": "CompoundType", - "tags": [], - "label": "hideCloseButton", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.OverlayFlyoutOpenOptions.outsideClickCloses", - "type": "CompoundType", - "tags": [], - "label": "outsideClickCloses", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.OverlayFlyoutOpenOptions.maskProps", - "type": "CompoundType", - "tags": [], - "label": "maskProps", - "description": [], - "signature": [ - "EuiOverlayMaskProps", - " | undefined" - ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.OverlayFlyoutOpenOptions.onClose", - "type": "Function", - "tags": [], - "label": "onClose", - "description": [ - "\nEuiFlyout onClose handler.\nIf provided the consumer is responsible for calling flyout.close() to close the flyout;" - ], - "signature": [ - "((flyout: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayRef", - "text": "OverlayRef" - }, - ") => void) | undefined" - ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.OverlayFlyoutOpenOptions.onClose.$1", - "type": "Object", + "id": "def-public.IExternalUrl.isInternalUrl.$1", + "type": "string", "tags": [], - "label": "flyout", + "label": "relativeOrAbsoluteUrl", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayRef", - "text": "OverlayRef" - } + "string" ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.OverlayFlyoutStart", - "type": "Interface", - "tags": [], - "label": "OverlayFlyoutStart", - "description": [ - "\nAPIs to open and manage fly-out dialogs.\n" - ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-public.OverlayFlyoutStart.open", + "id": "def-public.IExternalUrl.validateUrl", "type": "Function", - "tags": [ - "return" - ], - "label": "open", + "tags": [], + "label": "validateUrl", "description": [ - "\nOpens a flyout panel with the given mount point inside. You can use\n`close()` on the returned FlyoutRef to close the flyout.\n" + "\nDetermines if the provided URL is a valid location to send users.\nValidation is based on the configured allow list in kibana.yml.\n\nIf the URL is valid, then a URL will be returned.\nOtherwise, this will return null.\n" ], "signature": [ - "(mount: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayFlyoutOpenOptions", - "text": "OverlayFlyoutOpenOptions" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayRef", - "text": "OverlayRef" - } + "(relativeOrAbsoluteUrl: string) => URL | null" ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.OverlayFlyoutStart.open.$1", - "type": "Function", + "id": "def-public.IExternalUrl.validateUrl.$1", + "type": "string", "tags": [], - "label": "mount", - "description": [ - "{@link MountPoint } - Mounts the children inside a flyout panel" - ], + "label": "relativeOrAbsoluteUrl", + "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - "" + "string" ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-public.OverlayFlyoutStart.open.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [ - "{@link OverlayFlyoutOpenOptions } - options for the flyout" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayFlyoutOpenOptions", - "text": "OverlayFlyoutOpenOptions" - }, - " | undefined" - ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", - "deprecated": false, - "isRequired": false } ], "returnComment": [] @@ -4152,197 +4098,218 @@ }, { "parentPluginId": "core", - "id": "def-public.OverlayModalConfirmOptions", + "id": "def-public.IHttpFetchError", "type": "Interface", "tags": [], - "label": "OverlayModalConfirmOptions", + "label": "IHttpFetchError", "description": [], - "path": "src/core/public/overlays/modal/modal_service.tsx", + "signature": [ + "IHttpFetchError", + " extends Error" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.OverlayModalConfirmOptions.title", + "id": "def-public.IHttpFetchError.name", "type": "string", "tags": [], - "label": "title", + "label": "name", "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/core/public/overlays/modal/modal_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.OverlayModalConfirmOptions.cancelButtonText", - "type": "string", + "id": "def-public.IHttpFetchError.request", + "type": "Object", "tags": [], - "label": "cancelButtonText", + "label": "request", "description": [], "signature": [ - "string | undefined" + "Request" ], - "path": "src/core/public/overlays/modal/modal_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.OverlayModalConfirmOptions.confirmButtonText", - "type": "string", + "id": "def-public.IHttpFetchError.response", + "type": "Object", "tags": [], - "label": "confirmButtonText", + "label": "response", "description": [], "signature": [ - "string | undefined" + "Response | undefined" ], - "path": "src/core/public/overlays/modal/modal_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.OverlayModalConfirmOptions.className", - "type": "string", - "tags": [], - "label": "className", + "id": "def-public.IHttpFetchError.req", + "type": "Object", + "tags": [ + "deprecated" + ], + "label": "req", "description": [], "signature": [ - "string | undefined" + "Request" ], - "path": "src/core/public/overlays/modal/modal_service.tsx", - "deprecated": false + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": true, + "removeBy": "8.8.0\n\nNote to maintainers: when looking at usages, mind that typical use could be inside a `catch` block,\nso TS and code-reference navigation might not highlight them.", + "references": [ + { + "plugin": "ml", + "path": "x-pack/plugins/ml/common/util/errors/errors.test.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/common/util/errors/errors.test.ts" + }, + { + "plugin": "@kbn/core-http-browser-internal", + "path": "packages/core/http/core-http-browser-internal/src/http_fetch_error.ts" + }, + { + "plugin": "@kbn/core-http-browser-internal", + "path": "packages/core/http/core-http-browser-internal/src/http_fetch_error.ts" + } + ] }, { "parentPluginId": "core", - "id": "def-public.OverlayModalConfirmOptions.closeButtonAriaLabel", - "type": "string", - "tags": [], - "label": "closeButtonAriaLabel", + "id": "def-public.IHttpFetchError.res", + "type": "Object", + "tags": [ + "deprecated" + ], + "label": "res", "description": [], "signature": [ - "string | undefined" + "Response | undefined" ], - "path": "src/core/public/overlays/modal/modal_service.tsx", - "deprecated": false + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": true, + "removeBy": "8.8.0\n\nNote to maintainers: when looking at usages, mind that typical use could be inside a `catch` block,\nso TS and code-reference navigation might not highlight them.", + "references": [ + { + "plugin": "@kbn/core-http-browser-internal", + "path": "packages/core/http/core-http-browser-internal/src/http_fetch_error.ts" + }, + { + "plugin": "@kbn/core-http-browser-internal", + "path": "packages/core/http/core-http-browser-internal/src/http_fetch_error.ts" + } + ] }, { "parentPluginId": "core", - "id": "def-public.OverlayModalConfirmOptions.datatestsubj", - "type": "string", + "id": "def-public.IHttpFetchError.body", + "type": "Uncategorized", "tags": [], - "label": "'data-test-subj'", + "label": "body", "description": [], "signature": [ - "string | undefined" + "TResponseBody | undefined" ], - "path": "src/core/public/overlays/modal/modal_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.OverlayModalConfirmOptions.defaultFocusedButton", - "type": "CompoundType", - "tags": [], - "label": "defaultFocusedButton", - "description": [], - "signature": [ - "\"cancel\" | \"confirm\" | undefined" - ], - "path": "src/core/public/overlays/modal/modal_service.tsx", - "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.IHttpInterceptController", + "type": "Interface", + "tags": [], + "label": "IHttpInterceptController", + "description": [ + "\nUsed to halt a request Promise chain in a {@link HttpInterceptor}." + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-public.OverlayModalConfirmOptions.buttonColor", - "type": "CompoundType", + "id": "def-public.IHttpInterceptController.halted", + "type": "boolean", "tags": [], - "label": "buttonColor", - "description": [], - "signature": [ - "ButtonColor", - " | undefined" + "label": "halted", + "description": [ + "Whether or not this chain has been halted." ], - "path": "src/core/public/overlays/modal/modal_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.OverlayModalConfirmOptions.maxWidth", - "type": "CompoundType", + "id": "def-public.IHttpInterceptController.halt", + "type": "Function", "tags": [], - "label": "maxWidth", + "label": "halt", "description": [ - "\nSets the max-width of the modal.\nSet to `true` to use the default (`euiBreakpoints 'm'`),\nset to `false` to not restrict the width,\nset to a number for a custom width in px,\nset to a string for a custom width in custom measurement." + "Halt the request Promise chain and do not process further interceptors or response handlers." ], "signature": [ - "string | number | boolean | undefined" + "() => void" ], - "path": "src/core/public/overlays/modal/modal_service.tsx", - "deprecated": false + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.OverlayModalOpenOptions", + "id": "def-public.IHttpResponseInterceptorOverrides", "type": "Interface", "tags": [], - "label": "OverlayModalOpenOptions", - "description": [], - "path": "src/core/public/overlays/modal/modal_service.tsx", + "label": "IHttpResponseInterceptorOverrides", + "description": [ + "\nProperties that can be returned by HttpInterceptor.request to override the response." + ], + "signature": [ + "IHttpResponseInterceptorOverrides", + "" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.OverlayModalOpenOptions.className", - "type": "string", + "id": "def-public.IHttpResponseInterceptorOverrides.response", + "type": "Object", "tags": [], - "label": "className", - "description": [], - "signature": [ - "string | undefined" + "label": "response", + "description": [ + "Raw response received, may be undefined if there was an error." ], - "path": "src/core/public/overlays/modal/modal_service.tsx", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.OverlayModalOpenOptions.closeButtonAriaLabel", - "type": "string", - "tags": [], - "label": "closeButtonAriaLabel", - "description": [], "signature": [ - "string | undefined" + "Readonly | undefined" ], - "path": "src/core/public/overlays/modal/modal_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.OverlayModalOpenOptions.datatestsubj", - "type": "string", + "id": "def-public.IHttpResponseInterceptorOverrides.body", + "type": "Uncategorized", "tags": [], - "label": "'data-test-subj'", - "description": [], - "signature": [ - "string | undefined" + "label": "body", + "description": [ + "Parsed body received, may be undefined if there was an error." ], - "path": "src/core/public/overlays/modal/modal_service.tsx", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.OverlayModalOpenOptions.maxWidth", - "type": "CompoundType", - "tags": [], - "label": "maxWidth", - "description": [], "signature": [ - "string | number | boolean | undefined" + "TResponseBody | undefined" ], - "path": "src/core/public/overlays/modal/modal_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false } ], @@ -4350,229 +4317,154 @@ }, { "parentPluginId": "core", - "id": "def-public.OverlayModalStart", + "id": "def-public.IShipper", "type": "Interface", "tags": [], - "label": "OverlayModalStart", + "label": "IShipper", "description": [ - "\nAPIs to open and manage modal dialogs.\n" + "\nBasic structure of a Shipper" ], - "path": "src/core/public/overlays/modal/modal_service.tsx", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.OverlayModalStart.open", + "id": "def-public.IShipper.reportEvents", "type": "Function", - "tags": [ - "return" - ], - "label": "open", + "tags": [], + "label": "reportEvents", "description": [ - "\nOpens a modal panel with the given mount point inside. You can use\n`close()` on the returned OverlayRef to close the modal.\n" + "\nAdapts and ships the event to the persisting/analytics solution." ], "signature": [ - "(mount: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayModalOpenOptions", - "text": "OverlayModalOpenOptions" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayRef", - "text": "OverlayRef" - } + "(events: ", + "Event", + "[]) => void" ], - "path": "src/core/public/overlays/modal/modal_service.tsx", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.OverlayModalStart.open.$1", - "type": "Function", + "id": "def-public.IShipper.reportEvents.$1", + "type": "Array", "tags": [], - "label": "mount", + "label": "events", "description": [ - "{@link MountPoint } - Mounts the children inside the modal" + "batched events {@link Event }" ], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - "" + "Event", + "[]" ], - "path": "src/core/public/overlays/modal/modal_service.tsx", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true - }, + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-public.IShipper.optIn", + "type": "Function", + "tags": [], + "label": "optIn", + "description": [ + "\nStops/restarts the shipping mechanism based on the value of isOptedIn" + ], + "signature": [ + "(isOptedIn: boolean) => void" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-public.OverlayModalStart.open.$2", - "type": "Object", + "id": "def-public.IShipper.optIn.$1", + "type": "boolean", "tags": [], - "label": "options", + "label": "isOptedIn", "description": [ - "{@link OverlayModalOpenOptions } - options for the modal" + "`true` for resume sending events. `false` to stop." ], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayModalOpenOptions", - "text": "OverlayModalOpenOptions" - }, - " | undefined" + "boolean" ], - "path": "src/core/public/overlays/modal/modal_service.tsx", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.OverlayModalStart.openConfirm", + "id": "def-public.IShipper.extendContext", "type": "Function", "tags": [], - "label": "openConfirm", + "label": "extendContext", "description": [ - "\nOpens a confirmation modal with the given text or mountpoint as a message.\nReturns a Promise resolving to `true` if user confirmed or `false` otherwise.\n" + "\nPerform any necessary calls to the persisting/analytics solution to set the event's context." ], "signature": [ - "(message: string | ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayModalConfirmOptions", - "text": "OverlayModalConfirmOptions" - }, - " | undefined) => Promise" + "((newContext: ", + "EventContext", + ") => void) | undefined" ], - "path": "src/core/public/overlays/modal/modal_service.tsx", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.OverlayModalStart.openConfirm.$1", - "type": "CompoundType", + "id": "def-public.IShipper.extendContext.$1", + "type": "Object", "tags": [], - "label": "message", + "label": "newContext", "description": [ - "{@link MountPoint } - string or mountpoint to be used a the confirm message body" + "The full new context to set {@link EventContext }" ], "signature": [ - "string | ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - "" + "EventContext" ], - "path": "src/core/public/overlays/modal/modal_service.tsx", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-public.OverlayModalStart.openConfirm.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [ - "{@link OverlayModalConfirmOptions } - options for the confirm modal" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayModalConfirmOptions", - "text": "OverlayModalConfirmOptions" - }, - " | undefined" - ], - "path": "src/core/public/overlays/modal/modal_service.tsx", - "deprecated": false, - "isRequired": false } ], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.OverlayRef", - "type": "Interface", - "tags": [], - "label": "OverlayRef", - "description": [ - "\nReturned by {@link OverlayStart} methods for closing a mounted overlay." - ], - "path": "src/core/public/overlays/types.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-public.OverlayRef.onClose", + "id": "def-public.IShipper.telemetryCounter$", "type": "Object", "tags": [], - "label": "onClose", + "label": "telemetryCounter$", "description": [ - "\nA Promise that will resolve once this overlay is closed.\n\nOverlays can close from user interaction, calling `close()` on the overlay\nreference or another overlay replacing yours via `openModal` or `openFlyout`." + "\nObservable to emit the stats of the processed events." ], "signature": [ - "Promise" + "Observable", + "<", + "TelemetryCounter", + "> | undefined" ], - "path": "src/core/public/overlays/types.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.OverlayRef.close", + "id": "def-public.IShipper.shutdown", "type": "Function", "tags": [], - "label": "close", + "label": "shutdown", "description": [ - "\nCloses the referenced overlay if it's still open which in turn will\nresolve the `onClose` Promise. If the overlay had already been\nclosed this method does nothing." + "\nShutdown the shipper." ], "signature": [ - "() => Promise" + "() => void" ], - "path": "src/core/public/overlays/types.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [], "returnComment": [] @@ -4582,445 +4474,171 @@ }, { "parentPluginId": "core", - "id": "def-public.OverlayStart", + "id": "def-public.IUiSettingsClient", "type": "Interface", "tags": [], - "label": "OverlayStart", - "description": [], - "path": "src/core/public/overlays/overlay_service.ts", + "label": "IUiSettingsClient", + "description": [ + "\nClient-side client that provides access to the advanced settings stored in elasticsearch.\nThe settings provide control over the behavior of the Kibana application.\nFor example, a user can specify how to display numeric or date fields.\nUsers can adjust the settings via Management UI.\n{@link IUiSettingsClient}\n" + ], + "path": "src/core/public/ui_settings/types.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.OverlayStart.banners", - "type": "Object", - "tags": [], - "label": "banners", - "description": [ - "{@link OverlayBannersStart}" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayBannersStart", - "text": "OverlayBannersStart" - } - ], - "path": "src/core/public/overlays/overlay_service.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.OverlayStart.openFlyout", + "id": "def-public.IUiSettingsClient.get", "type": "Function", "tags": [], - "label": "openFlyout", + "label": "get", "description": [ - "{@link OverlayFlyoutStart#open}" + "\nGets the value for a specific uiSetting. If this setting has no user-defined value\nthen the `defaultOverride` parameter is returned (and parsed if setting is of type\n\"json\" or \"number). If the parameter is not defined and the key is not registered\nby any plugin then an error is thrown, otherwise reads the default value defined by a plugin." ], "signature": [ - "(mount: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayFlyoutOpenOptions", - "text": "OverlayFlyoutOpenOptions" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayRef", - "text": "OverlayRef" - } + "(key: string, defaultOverride?: T | undefined) => T" ], - "path": "src/core/public/overlays/overlay_service.ts", + "path": "src/core/public/ui_settings/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-public.OverlayStart.openFlyout.$1", - "type": "Function", + "id": "def-public.IUiSettingsClient.get.$1", + "type": "string", "tags": [], - "label": "mount", + "label": "key", "description": [], "signature": [ - "(element: HTMLElement) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.UnmountCallback", - "text": "UnmountCallback" - } + "string" ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "path": "src/core/public/ui_settings/types.ts", "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-public.OverlayStart.openFlyout.$1.$1", - "type": "Uncategorized", - "tags": [], - "label": "element", - "description": [], - "signature": [ - "T" - ], - "path": "src/core/public/types.ts", - "deprecated": false - } - ] + "isRequired": true }, { "parentPluginId": "core", - "id": "def-public.OverlayStart.openFlyout.$2", - "type": "Object", + "id": "def-public.IUiSettingsClient.get.$2", + "type": "Uncategorized", "tags": [], - "label": "options", + "label": "defaultOverride", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayFlyoutOpenOptions", - "text": "OverlayFlyoutOpenOptions" - }, - " | undefined" + "T | undefined" ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", - "deprecated": false + "path": "src/core/public/ui_settings/types.ts", + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.OverlayStart.openModal", + "id": "def-public.IUiSettingsClient.get$", "type": "Function", "tags": [], - "label": "openModal", + "label": "get$", "description": [ - "{@link OverlayModalStart#open}" + "\nGets an observable of the current value for a config key, and all updates to that config\nkey in the future. Providing a `defaultOverride` argument behaves the same as it does in #get()" ], "signature": [ - "(mount: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayModalOpenOptions", - "text": "OverlayModalOpenOptions" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayRef", - "text": "OverlayRef" - } + "(key: string, defaultOverride?: T | undefined) => ", + "Observable", + "" ], - "path": "src/core/public/overlays/overlay_service.ts", + "path": "src/core/public/ui_settings/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-public.OverlayStart.openModal.$1", - "type": "Function", + "id": "def-public.IUiSettingsClient.get$.$1", + "type": "string", "tags": [], - "label": "mount", + "label": "key", "description": [], "signature": [ - "(element: HTMLElement) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.UnmountCallback", - "text": "UnmountCallback" - } + "string" ], - "path": "src/core/public/overlays/modal/modal_service.tsx", + "path": "src/core/public/ui_settings/types.ts", "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-public.OverlayStart.openModal.$1.$1", - "type": "Uncategorized", - "tags": [], - "label": "element", - "description": [], - "signature": [ - "T" - ], - "path": "src/core/public/types.ts", - "deprecated": false - } - ] + "isRequired": true }, { "parentPluginId": "core", - "id": "def-public.OverlayStart.openModal.$2", - "type": "Object", + "id": "def-public.IUiSettingsClient.get$.$2", + "type": "Uncategorized", "tags": [], - "label": "options", + "label": "defaultOverride", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayModalOpenOptions", - "text": "OverlayModalOpenOptions" - }, - " | undefined" + "T | undefined" ], - "path": "src/core/public/overlays/modal/modal_service.tsx", - "deprecated": false + "path": "src/core/public/ui_settings/types.ts", + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.OverlayStart.openConfirm", + "id": "def-public.IUiSettingsClient.getAll", "type": "Function", "tags": [], - "label": "openConfirm", + "label": "getAll", "description": [ - "{@link OverlayModalStart#openConfirm}" + "\nGets the metadata about all uiSettings, including the type, default value, and user value\nfor each key." ], "signature": [ - "(message: string | ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayModalConfirmOptions", - "text": "OverlayModalConfirmOptions" - }, - " | undefined) => Promise" + "() => Readonly>>" ], - "path": "src/core/public/overlays/overlay_service.ts", + "path": "src/core/public/ui_settings/types.ts", "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-public.OverlayStart.openConfirm.$1", - "type": "CompoundType", - "tags": [], - "label": "message", - "description": [], - "signature": [ - "string | ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - "" - ], - "path": "src/core/public/overlays/modal/modal_service.tsx", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.OverlayStart.openConfirm.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayModalConfirmOptions", - "text": "OverlayModalConfirmOptions" - }, - " | undefined" - ], - "path": "src/core/public/overlays/modal/modal_service.tsx", - "deprecated": false - } - ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.PackageInfo", - "type": "Interface", - "tags": [], - "label": "PackageInfo", - "description": [], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.PackageInfo.version", - "type": "string", - "tags": [], - "label": "version", - "description": [], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.PackageInfo.branch", - "type": "string", - "tags": [], - "label": "branch", - "description": [], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.PackageInfo.buildNum", - "type": "number", - "tags": [], - "label": "buildNum", - "description": [], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.PackageInfo.buildSha", - "type": "string", - "tags": [], - "label": "buildSha", - "description": [], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.PackageInfo.dist", - "type": "boolean", - "tags": [], - "label": "dist", - "description": [], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.Plugin", - "type": "Interface", - "tags": [], - "label": "Plugin", - "description": [ - "\nThe interface that should be returned by a `PluginInitializer`.\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Plugin", - "text": "Plugin" + "children": [], + "returnComment": [] }, - "" - ], - "path": "src/core/public/plugins/plugin.ts", - "deprecated": false, - "children": [ { "parentPluginId": "core", - "id": "def-public.Plugin.setup", + "id": "def-public.IUiSettingsClient.set", "type": "Function", "tags": [], - "label": "setup", - "description": [], + "label": "set", + "description": [ + "\nSets the value for a uiSetting. If the setting is not registered by any plugin\nit will be stored as a custom setting. The new value will be synchronously available via\nthe `get()` method and sent to the server in the background. If the request to the\nserver fails then a updateErrors$ will be notified and the setting will be\nreverted to its value before `set()` was called." + ], "signature": [ - "(core: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.CoreSetup", - "text": "CoreSetup" - }, - ", plugins: TPluginsSetup) => TSetup" + "(key: string, value: any) => Promise" ], - "path": "src/core/public/plugins/plugin.ts", + "path": "src/core/public/ui_settings/types.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.Plugin.setup.$1", - "type": "Object", + "id": "def-public.IUiSettingsClient.set.$1", + "type": "string", "tags": [], - "label": "core", + "label": "key", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.CoreSetup", - "text": "CoreSetup" - }, - "" + "string" ], - "path": "src/core/public/plugins/plugin.ts", + "path": "src/core/public/ui_settings/types.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-public.Plugin.setup.$2", - "type": "Uncategorized", + "id": "def-public.IUiSettingsClient.set.$2", + "type": "Any", "tags": [], - "label": "plugins", + "label": "value", "description": [], "signature": [ - "TPluginsSetup" + "any" ], - "path": "src/core/public/plugins/plugin.ts", + "path": "src/core/public/ui_settings/types.ts", "deprecated": false, "isRequired": true } @@ -5029,56 +4647,62 @@ }, { "parentPluginId": "core", - "id": "def-public.Plugin.start", + "id": "def-public.IUiSettingsClient.remove", "type": "Function", "tags": [], - "label": "start", - "description": [], + "label": "remove", + "description": [ + "\nRemoves the user-defined value for a setting, causing it to revert to the default. This\nmethod behaves the same as calling `set(key, null)`, including the synchronization, custom\nsetting, and error behavior of that method." + ], "signature": [ - "(core: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.CoreStart", - "text": "CoreStart" - }, - ", plugins: TPluginsStart) => TStart" + "(key: string) => Promise" ], - "path": "src/core/public/plugins/plugin.ts", + "path": "src/core/public/ui_settings/types.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.Plugin.start.$1", - "type": "Object", + "id": "def-public.IUiSettingsClient.remove.$1", + "type": "string", "tags": [], - "label": "core", + "label": "key", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.CoreStart", - "text": "CoreStart" - } + "string" ], - "path": "src/core/public/plugins/plugin.ts", + "path": "src/core/public/ui_settings/types.ts", "deprecated": false, "isRequired": true - }, + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-public.IUiSettingsClient.isDeclared", + "type": "Function", + "tags": [], + "label": "isDeclared", + "description": [ + "\nReturns true if the key is a \"known\" uiSetting, meaning it is either registered\nby any plugin or was previously added as a custom setting via the `set()` method." + ], + "signature": [ + "(key: string) => boolean" + ], + "path": "src/core/public/ui_settings/types.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-public.Plugin.start.$2", - "type": "Uncategorized", + "id": "def-public.IUiSettingsClient.isDeclared.$1", + "type": "string", "tags": [], - "label": "plugins", + "label": "key", "description": [], "signature": [ - "TPluginsStart" + "string" ], - "path": "src/core/public/plugins/plugin.ts", + "path": "src/core/public/ui_settings/types.ts", "deprecated": false, "isRequired": true } @@ -5087,264 +4711,310 @@ }, { "parentPluginId": "core", - "id": "def-public.Plugin.stop", + "id": "def-public.IUiSettingsClient.isDefault", "type": "Function", "tags": [], - "label": "stop", - "description": [], + "label": "isDefault", + "description": [ + "\nReturns true if the setting has no user-defined value or is unknown" + ], "signature": [ - "(() => void) | undefined" + "(key: string) => boolean" ], - "path": "src/core/public/plugins/plugin.ts", + "path": "src/core/public/ui_settings/types.ts", "deprecated": false, - "children": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.IUiSettingsClient.isDefault.$1", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "signature": [ + "string" + ], + "path": "src/core/public/ui_settings/types.ts", + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.PluginInitializerContext", - "type": "Interface", - "tags": [], - "label": "PluginInitializerContext", - "description": [ - "\nThe available core services passed to a `PluginInitializer`\n" - ], - "signature": [ + }, { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.PluginInitializerContext", - "text": "PluginInitializerContext" + "parentPluginId": "core", + "id": "def-public.IUiSettingsClient.isCustom", + "type": "Function", + "tags": [], + "label": "isCustom", + "description": [ + "\nReturns true if the setting wasn't registered by any plugin, but was either\nadded directly via `set()`, or is an unknown setting found in the uiSettings saved\nobject" + ], + "signature": [ + "(key: string) => boolean" + ], + "path": "src/core/public/ui_settings/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.IUiSettingsClient.isCustom.$1", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "signature": [ + "string" + ], + "path": "src/core/public/ui_settings/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, - "" - ], - "path": "src/core/public/plugins/plugin_context.ts", - "deprecated": false, - "children": [ { "parentPluginId": "core", - "id": "def-public.PluginInitializerContext.opaqueId", - "type": "Uncategorized", + "id": "def-public.IUiSettingsClient.isOverridden", + "type": "Function", "tags": [], - "label": "opaqueId", + "label": "isOverridden", "description": [ - "\nA symbol used to identify this plugin in the system. Needed when registering handlers or context providers." + "\nShows whether the uiSettings value set by the user." ], "signature": [ - "symbol" + "(key: string) => boolean" ], - "path": "src/core/public/plugins/plugin_context.ts", - "deprecated": false + "path": "src/core/public/ui_settings/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.IUiSettingsClient.isOverridden.$1", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "signature": [ + "string" + ], + "path": "src/core/public/ui_settings/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.PluginInitializerContext.env", - "type": "Object", + "id": "def-public.IUiSettingsClient.getUpdate$", + "type": "Function", "tags": [], - "label": "env", - "description": [], + "label": "getUpdate$", + "description": [ + "\nReturns an Observable that notifies subscribers of each update to the uiSettings,\nincluding the key, newValue, and oldValue of the setting that changed." + ], "signature": [ - "{ mode: Readonly<", - "EnvironmentMode", - ">; packageInfo: Readonly<", - "PackageInfo", - ">; }" + "() => ", + "Observable", + "<{ key: string; newValue: T; oldValue: T; }>" ], - "path": "src/core/public/plugins/plugin_context.ts", - "deprecated": false + "path": "src/core/public/ui_settings/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.PluginInitializerContext.config", - "type": "Object", + "id": "def-public.IUiSettingsClient.getUpdateErrors$", + "type": "Function", "tags": [], - "label": "config", - "description": [], + "label": "getUpdateErrors$", + "description": [ + "\nReturns an Observable that notifies subscribers of each error while trying to update\nthe settings, containing the actual Error class." + ], "signature": [ - "{ get: () => T; }" + "() => ", + "Observable", + "" ], - "path": "src/core/public/plugins/plugin_context.ts", - "deprecated": false + "path": "src/core/public/ui_settings/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.SavedObject", + "id": "def-public.NotificationsSetup", "type": "Interface", "tags": [], - "label": "SavedObject", + "label": "NotificationsSetup", "description": [], - "signature": [ - "SavedObject", - "" - ], - "path": "src/core/types/saved_objects.ts", + "path": "src/core/public/notifications/notifications_service.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObject.id", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObject.type", - "type": "string", - "tags": [], - "label": "type", - "description": [ - " The type of Saved Object. Each plugin can define it's own custom Saved Object types." - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObject.version", - "type": "string", - "tags": [], - "label": "version", - "description": [ - "An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObject.updated_at", - "type": "string", + "id": "def-public.NotificationsSetup.toasts", + "type": "Object", "tags": [], - "label": "updated_at", + "label": "toasts", "description": [ - "Timestamp of the last time this document had been updated." + "{@link ToastsSetup}" ], "signature": [ - "string | undefined" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObject.error", - "type": "Object", - "tags": [], - "label": "error", - "description": [], - "signature": [ - "SavedObjectError", - " | undefined" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObject.attributes", - "type": "Uncategorized", - "tags": [], - "label": "attributes", - "description": [ - "{@inheritdoc SavedObjectAttributes}" - ], - "signature": [ - "T" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObject.references", - "type": "Array", - "tags": [], - "label": "references", - "description": [ - "{@inheritdoc SavedObjectReference}" - ], - "signature": [ - "SavedObjectReference", - "[]" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObject.migrationVersion", - "type": "Object", - "tags": [], - "label": "migrationVersion", - "description": [ - "{@inheritdoc SavedObjectsMigrationVersion}" - ], - "signature": [ - "SavedObjectsMigrationVersion", - " | undefined" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObject.coreMigrationVersion", - "type": "string", - "tags": [], - "label": "coreMigrationVersion", - "description": [ - "A semver value that is used when upgrading objects between Kibana versions." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObject.namespaces", - "type": "Array", - "tags": [], - "label": "namespaces", - "description": [ - "\nSpace(s) that this saved object exists in. This attribute is not used for \"global\" saved object types which are registered with\n`namespaceType: 'agnostic'`." - ], - "signature": [ - "string[] | undefined" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObject.originId", - "type": "string", - "tags": [], - "label": "originId", - "description": [ - "\nThe ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration\nfrom a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import\nto ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given\nspace." - ], - "signature": [ - "string | undefined" + "{ add: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; get$: () => ", + "Observable", + "<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "[]>; remove: (toastOrId: string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + ") => void; addSuccess: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addWarning: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addDanger: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addError: (error: Error, options: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ErrorToastOptions", + "text": "ErrorToastOptions" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addInfo: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; }" ], - "path": "src/core/types/saved_objects.ts", + "path": "src/core/public/notifications/notifications_service.ts", "deprecated": false } ], @@ -5352,28 +5022,173 @@ }, { "parentPluginId": "core", - "id": "def-public.SavedObjectAttributes", + "id": "def-public.NotificationsStart", "type": "Interface", "tags": [], - "label": "SavedObjectAttributes", - "description": [ - "\nThe data for a Saved Object is stored as an object in the `attributes`\nproperty.\n" - ], - "path": "src/core/types/saved_objects.ts", + "label": "NotificationsStart", + "description": [], + "path": "src/core/public/notifications/notifications_service.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectAttributes.Unnamed", - "type": "IndexSignature", + "id": "def-public.NotificationsStart.toasts", + "type": "Object", "tags": [], - "label": "[key: string]: SavedObjectAttribute", - "description": [], + "label": "toasts", + "description": [ + "{@link ToastsStart}" + ], "signature": [ - "[key: string]: ", - "SavedObjectAttribute" + "{ add: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; get$: () => ", + "Observable", + "<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "[]>; remove: (toastOrId: string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + ") => void; addSuccess: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addWarning: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addDanger: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addError: (error: Error, options: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ErrorToastOptions", + "text": "ErrorToastOptions" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addInfo: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; }" ], - "path": "src/core/types/saved_objects.ts", + "path": "src/core/public/notifications/notifications_service.ts", "deprecated": false } ], @@ -5381,55 +5196,46 @@ }, { "parentPluginId": "core", - "id": "def-public.SavedObjectError", + "id": "def-public.OptInConfig", "type": "Interface", "tags": [], - "label": "SavedObjectError", - "description": [], - "path": "src/core/types/saved_objects.ts", + "label": "OptInConfig", + "description": [ + "\n" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectError.error", - "type": "string", - "tags": [], - "label": "error", - "description": [], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectError.message", - "type": "string", - "tags": [], - "label": "message", - "description": [], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectError.statusCode", - "type": "number", + "id": "def-public.OptInConfig.global", + "type": "Object", "tags": [], - "label": "statusCode", - "description": [], - "path": "src/core/types/saved_objects.ts", + "label": "global", + "description": [ + "\nControls the global enabled/disabled behaviour of the client and shippers." + ], + "signature": [ + "OptInConfigPerType" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectError.metadata", + "id": "def-public.OptInConfig.event_types", "type": "Object", "tags": [], - "label": "metadata", - "description": [], + "label": "event_types", + "description": [ + "\nControls if an event type should be disabled for a specific type of shipper." + ], "signature": [ - "Record | undefined" + "Record | undefined" ], - "path": "src/core/types/saved_objects.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false } ], @@ -5437,882 +5243,1303 @@ }, { "parentPluginId": "core", - "id": "def-public.SavedObjectReference", + "id": "def-public.OverlayBannersStart", "type": "Interface", "tags": [], - "label": "SavedObjectReference", - "description": [ - "\nA reference to another saved object.\n" - ], - "path": "src/core/types/saved_objects.ts", + "label": "OverlayBannersStart", + "description": [], + "path": "src/core/public/overlays/banners/banners_service.tsx", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectReference.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectReference.type", - "type": "string", + "id": "def-public.OverlayBannersStart.add", + "type": "Function", "tags": [], - "label": "type", - "description": [], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { + "label": "add", + "description": [ + "\nAdd a new banner\n" + ], + "signature": [ + "(mount: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + ", priority?: number | undefined) => string" + ], + "path": "src/core/public/overlays/banners/banners_service.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.OverlayBannersStart.add.$1", + "type": "Function", + "tags": [], + "label": "mount", + "description": [ + "{@link MountPoint }" + ], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + "" + ], + "path": "src/core/public/overlays/banners/banners_service.tsx", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.OverlayBannersStart.add.$2", + "type": "number", + "tags": [], + "label": "priority", + "description": [ + "optional priority order to display this banner. Higher priority values are shown first." + ], + "signature": [ + "number | undefined" + ], + "path": "src/core/public/overlays/banners/banners_service.tsx", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "a unique identifier for the given banner to be used with {@link OverlayBannersStart.remove } and\n{@link OverlayBannersStart.replace }" + ] + }, + { "parentPluginId": "core", - "id": "def-public.SavedObjectReference.id", - "type": "string", + "id": "def-public.OverlayBannersStart.remove", + "type": "Function", "tags": [], - "label": "id", + "label": "remove", + "description": [ + "\nRemove a banner\n" + ], + "signature": [ + "(id: string) => boolean" + ], + "path": "src/core/public/overlays/banners/banners_service.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.OverlayBannersStart.remove.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "the unique identifier for the banner returned by {@link OverlayBannersStart.add }" + ], + "signature": [ + "string" + ], + "path": "src/core/public/overlays/banners/banners_service.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "if the banner was found or not" + ] + }, + { + "parentPluginId": "core", + "id": "def-public.OverlayBannersStart.replace", + "type": "Function", + "tags": [], + "label": "replace", + "description": [ + "\nReplace a banner in place\n" + ], + "signature": [ + "(id: string | undefined, mount: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + ", priority?: number | undefined) => string" + ], + "path": "src/core/public/overlays/banners/banners_service.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.OverlayBannersStart.replace.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "the unique identifier for the banner returned by {@link OverlayBannersStart.add }" + ], + "signature": [ + "string | undefined" + ], + "path": "src/core/public/overlays/banners/banners_service.tsx", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "core", + "id": "def-public.OverlayBannersStart.replace.$2", + "type": "Function", + "tags": [], + "label": "mount", + "description": [ + "{@link MountPoint }" + ], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + "" + ], + "path": "src/core/public/overlays/banners/banners_service.tsx", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.OverlayBannersStart.replace.$3", + "type": "number", + "tags": [], + "label": "priority", + "description": [ + "optional priority order to display this banner. Higher priority values are shown first." + ], + "signature": [ + "number | undefined" + ], + "path": "src/core/public/overlays/banners/banners_service.tsx", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "a new identifier for the given banner to be used with {@link OverlayBannersStart.remove } and\n{@link OverlayBannersStart.replace }" + ] + }, + { + "parentPluginId": "core", + "id": "def-public.OverlayBannersStart.getComponent", + "type": "Function", + "tags": [], + "label": "getComponent", "description": [], - "path": "src/core/types/saved_objects.ts", - "deprecated": false + "signature": [ + "() => JSX.Element" + ], + "path": "src/core/public/overlays/banners/banners_service.tsx", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectReferenceWithContext", + "id": "def-public.OverlayFlyoutOpenOptions", "type": "Interface", "tags": [], - "label": "SavedObjectReferenceWithContext", - "description": [ - "\nA returned input object or one of its references, with additional context.\n" - ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "label": "OverlayFlyoutOpenOptions", + "description": [], + "path": "src/core/public/overlays/flyout/flyout_service.tsx", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectReferenceWithContext.type", + "id": "def-public.OverlayFlyoutOpenOptions.className", "type": "string", "tags": [], - "label": "type", - "description": [ - "The type of the referenced object" + "label": "className", + "description": [], + "signature": [ + "string | undefined" ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "path": "src/core/public/overlays/flyout/flyout_service.tsx", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectReferenceWithContext.id", + "id": "def-public.OverlayFlyoutOpenOptions.closeButtonAriaLabel", "type": "string", "tags": [], - "label": "id", - "description": [ - "The ID of the referenced object" + "label": "closeButtonAriaLabel", + "description": [], + "signature": [ + "string | undefined" ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "path": "src/core/public/overlays/flyout/flyout_service.tsx", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectReferenceWithContext.originId", - "type": "string", + "id": "def-public.OverlayFlyoutOpenOptions.ownFocus", + "type": "CompoundType", "tags": [], - "label": "originId", - "description": [ - "The origin ID of the referenced object (if it has one)" - ], + "label": "ownFocus", + "description": [], "signature": [ - "string | undefined" + "boolean | undefined" ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "path": "src/core/public/overlays/flyout/flyout_service.tsx", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectReferenceWithContext.spaces", - "type": "Array", + "id": "def-public.OverlayFlyoutOpenOptions.datatestsubj", + "type": "string", "tags": [], - "label": "spaces", - "description": [ - "The space(s) that the referenced object exists in" - ], + "label": "'data-test-subj'", + "description": [], "signature": [ - "string[]" + "string | undefined" ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "path": "src/core/public/overlays/flyout/flyout_service.tsx", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectReferenceWithContext.inboundReferences", - "type": "Array", + "id": "def-public.OverlayFlyoutOpenOptions.arialabel", + "type": "string", "tags": [], - "label": "inboundReferences", - "description": [ - "\nReferences to this object; note that this does not contain _all inbound references everywhere for this object_, it only contains\ninbound references for the scope of this operation" + "label": "'aria-label'", + "description": [], + "signature": [ + "string | undefined" ], + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.OverlayFlyoutOpenOptions.size", + "type": "CompoundType", + "tags": [], + "label": "size", + "description": [], "signature": [ - "{ type: string; id: string; name: string; }[]" + "\"m\" | \"s\" | \"l\" | undefined" ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "path": "src/core/public/overlays/flyout/flyout_service.tsx", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectReferenceWithContext.isMissing", + "id": "def-public.OverlayFlyoutOpenOptions.maxWidth", "type": "CompoundType", "tags": [], - "label": "isMissing", - "description": [ - "Whether or not this object or reference is missing" + "label": "maxWidth", + "description": [], + "signature": [ + "string | number | boolean | undefined" ], + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.OverlayFlyoutOpenOptions.hideCloseButton", + "type": "CompoundType", + "tags": [], + "label": "hideCloseButton", + "description": [], "signature": [ "boolean | undefined" ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "path": "src/core/public/overlays/flyout/flyout_service.tsx", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectReferenceWithContext.spacesWithMatchingAliases", - "type": "Array", + "id": "def-public.OverlayFlyoutOpenOptions.outsideClickCloses", + "type": "CompoundType", "tags": [], - "label": "spacesWithMatchingAliases", - "description": [ - "The space(s) that legacy URL aliases matching this type/id exist in" + "label": "outsideClickCloses", + "description": [], + "signature": [ + "boolean | undefined" ], + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.OverlayFlyoutOpenOptions.maskProps", + "type": "CompoundType", + "tags": [], + "label": "maskProps", + "description": [], "signature": [ - "string[] | undefined" + "EuiOverlayMaskProps", + " | undefined" ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "path": "src/core/public/overlays/flyout/flyout_service.tsx", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectReferenceWithContext.spacesWithMatchingOrigins", - "type": "Array", + "id": "def-public.OverlayFlyoutOpenOptions.onClose", + "type": "Function", "tags": [], - "label": "spacesWithMatchingOrigins", + "label": "onClose", "description": [ - "The space(s) that objects matching this origin exist in (including this one)" + "\nEuiFlyout onClose handler.\nIf provided the consumer is responsible for calling flyout.close() to close the flyout;" ], "signature": [ - "string[] | undefined" + "((flyout: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayRef", + "text": "OverlayRef" + }, + ") => void) | undefined" ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "deprecated": false + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.OverlayFlyoutOpenOptions.onClose.$1", + "type": "Object", + "tags": [], + "label": "flyout", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayRef", + "text": "OverlayRef" + } + ], + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsBaseOptions", + "id": "def-public.OverlayFlyoutStart", "type": "Interface", "tags": [], - "label": "SavedObjectsBaseOptions", + "label": "OverlayFlyoutStart", "description": [ - "\n" + "\nAPIs to open and manage fly-out dialogs.\n" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "src/core/public/overlays/flyout/flyout_service.tsx", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsBaseOptions.namespace", - "type": "string", - "tags": [], - "label": "namespace", + "id": "def-public.OverlayFlyoutStart.open", + "type": "Function", + "tags": [ + "return" + ], + "label": "open", "description": [ - "Specify the namespace for this operation" + "\nOpens a flyout panel with the given mount point inside. You can use\n`close()` on the returned FlyoutRef to close the flyout.\n" ], "signature": [ - "string | undefined" + "(mount: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayFlyoutOpenOptions", + "text": "OverlayFlyoutOpenOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayRef", + "text": "OverlayRef" + } ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.OverlayFlyoutStart.open.$1", + "type": "Function", + "tags": [], + "label": "mount", + "description": [ + "{@link MountPoint } - Mounts the children inside a flyout panel" + ], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + "" + ], + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.OverlayFlyoutStart.open.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "{@link OverlayFlyoutOpenOptions } - options for the flyout" + ], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayFlyoutOpenOptions", + "text": "OverlayFlyoutOpenOptions" + }, + " | undefined" + ], + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkResolveObject", + "id": "def-public.OverlayModalConfirmOptions", "type": "Interface", "tags": [], - "label": "SavedObjectsBulkResolveObject", - "description": [ - "\n" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "label": "OverlayModalConfirmOptions", + "description": [], + "path": "src/core/public/overlays/modal/modal_service.tsx", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkResolveObject.id", + "id": "def-public.OverlayModalConfirmOptions.title", "type": "string", "tags": [], - "label": "id", + "label": "title", "description": [], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "signature": [ + "string | undefined" + ], + "path": "src/core/public/overlays/modal/modal_service.tsx", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkResolveObject.type", + "id": "def-public.OverlayModalConfirmOptions.cancelButtonText", "type": "string", "tags": [], - "label": "type", + "label": "cancelButtonText", "description": [], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "signature": [ + "string | undefined" + ], + "path": "src/core/public/overlays/modal/modal_service.tsx", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsCollectMultiNamespaceReferencesResponse", - "type": "Interface", - "tags": [], - "label": "SavedObjectsCollectMultiNamespaceReferencesResponse", - "description": [ - "\nThe response when object references are collected.\n" - ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsCollectMultiNamespaceReferencesResponse.objects", - "type": "Array", + "id": "def-public.OverlayModalConfirmOptions.confirmButtonText", + "type": "string", "tags": [], - "label": "objects", + "label": "confirmButtonText", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectReferenceWithContext", - "text": "SavedObjectReferenceWithContext" - }, - "[]" + "string | undefined" ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "path": "src/core/public/overlays/modal/modal_service.tsx", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsFindOptions", - "description": [ - "\n" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.type", - "type": "CompoundType", + "id": "def-public.OverlayModalConfirmOptions.className", + "type": "string", "tags": [], - "label": "type", + "label": "className", "description": [], "signature": [ - "string | string[]" + "string | undefined" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "src/core/public/overlays/modal/modal_service.tsx", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.page", - "type": "number", + "id": "def-public.OverlayModalConfirmOptions.closeButtonAriaLabel", + "type": "string", "tags": [], - "label": "page", + "label": "closeButtonAriaLabel", "description": [], "signature": [ - "number | undefined" + "string | undefined" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "src/core/public/overlays/modal/modal_service.tsx", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.perPage", - "type": "number", + "id": "def-public.OverlayModalConfirmOptions.datatestsubj", + "type": "string", "tags": [], - "label": "perPage", + "label": "'data-test-subj'", "description": [], "signature": [ - "number | undefined" + "string | undefined" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "src/core/public/overlays/modal/modal_service.tsx", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.sortField", - "type": "string", + "id": "def-public.OverlayModalConfirmOptions.defaultFocusedButton", + "type": "CompoundType", "tags": [], - "label": "sortField", + "label": "defaultFocusedButton", "description": [], "signature": [ - "string | undefined" + "\"cancel\" | \"confirm\" | undefined" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "src/core/public/overlays/modal/modal_service.tsx", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.sortOrder", + "id": "def-public.OverlayModalConfirmOptions.buttonColor", "type": "CompoundType", "tags": [], - "label": "sortOrder", + "label": "buttonColor", "description": [], "signature": [ - "SortOrder", + "ButtonColor", " | undefined" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "src/core/public/overlays/modal/modal_service.tsx", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.fields", - "type": "Array", + "id": "def-public.OverlayModalConfirmOptions.maxWidth", + "type": "CompoundType", "tags": [], - "label": "fields", + "label": "maxWidth", "description": [ - "\nAn array of fields to include in the results" + "\nSets the max-width of the modal.\nSet to `true` to use the default (`euiBreakpoints 'm'`),\nset to `false` to not restrict the width,\nset to a number for a custom width in px,\nset to a string for a custom width in custom measurement." ], "signature": [ - "string[] | undefined" + "string | number | boolean | undefined" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "src/core/public/overlays/modal/modal_service.tsx", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.OverlayModalOpenOptions", + "type": "Interface", + "tags": [], + "label": "OverlayModalOpenOptions", + "description": [], + "path": "src/core/public/overlays/modal/modal_service.tsx", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.search", + "id": "def-public.OverlayModalOpenOptions.className", "type": "string", "tags": [], - "label": "search", - "description": [ - "Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String `query` argument for more information" - ], + "label": "className", + "description": [], "signature": [ "string | undefined" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "src/core/public/overlays/modal/modal_service.tsx", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.searchFields", - "type": "Array", + "id": "def-public.OverlayModalOpenOptions.closeButtonAriaLabel", + "type": "string", "tags": [], - "label": "searchFields", - "description": [ - "The fields to perform the parsed query against. See Elasticsearch Simple Query String `fields` argument for more information" - ], + "label": "closeButtonAriaLabel", + "description": [], "signature": [ - "string[] | undefined" + "string | undefined" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "src/core/public/overlays/modal/modal_service.tsx", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.searchAfter", - "type": "Array", + "id": "def-public.OverlayModalOpenOptions.datatestsubj", + "type": "string", "tags": [], - "label": "searchAfter", - "description": [ - "\nUse the sort values from the previous page to retrieve the next page of results." - ], + "label": "'data-test-subj'", + "description": [], "signature": [ - "string[] | undefined" + "string | undefined" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "src/core/public/overlays/modal/modal_service.tsx", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.rootSearchFields", - "type": "Array", + "id": "def-public.OverlayModalOpenOptions.maxWidth", + "type": "CompoundType", "tags": [], - "label": "rootSearchFields", - "description": [ - "\nThe fields to perform the parsed query against. Unlike the `searchFields` argument, these are expected to be root fields and will not\nbe modified. If used in conjunction with `searchFields`, both are concatenated together." - ], + "label": "maxWidth", + "description": [], "signature": [ - "string[] | undefined" + "string | number | boolean | undefined" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "src/core/public/overlays/modal/modal_service.tsx", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.OverlayModalStart", + "type": "Interface", + "tags": [], + "label": "OverlayModalStart", + "description": [ + "\nAPIs to open and manage modal dialogs.\n" + ], + "path": "src/core/public/overlays/modal/modal_service.tsx", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.hasReference", - "type": "CompoundType", - "tags": [], - "label": "hasReference", + "id": "def-public.OverlayModalStart.open", + "type": "Function", + "tags": [ + "return" + ], + "label": "open", "description": [ - "\nSearch for documents having a reference to the specified objects.\nUse `hasReferenceOperator` to specify the operator to use when searching for multiple references." + "\nOpens a modal panel with the given mount point inside. You can use\n`close()` on the returned OverlayRef to close the modal.\n" ], "signature": [ + "(mount: ", { "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptionsReference", - "text": "SavedObjectsFindOptionsReference" + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" }, - " | ", + ", options?: ", { "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptionsReference", - "text": "SavedObjectsFindOptionsReference" + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayModalOpenOptions", + "text": "OverlayModalOpenOptions" }, - "[] | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.hasReferenceOperator", - "type": "CompoundType", - "tags": [], - "label": "hasReferenceOperator", - "description": [ - "\nThe operator to use when searching by multiple references using the `hasReference` option. Defaults to `OR`" - ], - "signature": [ - "\"AND\" | \"OR\" | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.defaultSearchOperator", - "type": "CompoundType", - "tags": [], - "label": "defaultSearchOperator", - "description": [ - "\nThe search operator to use with the provided filter. Defaults to `OR`" - ], - "signature": [ - "\"AND\" | \"OR\" | undefined" + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayRef", + "text": "OverlayRef" + } ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.filter", - "type": "Any", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "any" + "path": "src/core/public/overlays/modal/modal_service.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.OverlayModalStart.open.$1", + "type": "Function", + "tags": [], + "label": "mount", + "description": [ + "{@link MountPoint } - Mounts the children inside the modal" + ], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + "" + ], + "path": "src/core/public/overlays/modal/modal_service.tsx", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.OverlayModalStart.open.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "{@link OverlayModalOpenOptions } - options for the modal" + ], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayModalOpenOptions", + "text": "OverlayModalOpenOptions" + }, + " | undefined" + ], + "path": "src/core/public/overlays/modal/modal_service.tsx", + "deprecated": false, + "isRequired": false + } ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.aggs", - "type": "Object", - "tags": [ - "alpha" - ], - "label": "aggs", + "id": "def-public.OverlayModalStart.openConfirm", + "type": "Function", + "tags": [], + "label": "openConfirm", "description": [ - "\nA record of aggregations to perform.\nThe API currently only supports a limited set of metrics and bucket aggregation types.\nAdditional aggregation types can be contributed to Core.\n" + "\nOpens a confirmation modal with the given text or mountpoint as a message.\nReturns a Promise resolving to `true` if user confirmed or `false` otherwise.\n" ], "signature": [ - "Record | undefined" + "(message: string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayModalConfirmOptions", + "text": "OverlayModalConfirmOptions" + }, + " | undefined) => Promise" ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.namespaces", - "type": "Array", - "tags": [], - "label": "namespaces", - "description": [], - "signature": [ - "string[] | undefined" + "path": "src/core/public/overlays/modal/modal_service.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.OverlayModalStart.openConfirm.$1", + "type": "CompoundType", + "tags": [], + "label": "message", + "description": [ + "{@link MountPoint } - string or mountpoint to be used a the confirm message body" + ], + "signature": [ + "string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + "" + ], + "path": "src/core/public/overlays/modal/modal_service.tsx", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.OverlayModalStart.openConfirm.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "{@link OverlayModalConfirmOptions } - options for the confirm modal" + ], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayModalConfirmOptions", + "text": "OverlayModalConfirmOptions" + }, + " | undefined" + ], + "path": "src/core/public/overlays/modal/modal_service.tsx", + "deprecated": false, + "isRequired": false + } ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.OverlayRef", + "type": "Interface", + "tags": [], + "label": "OverlayRef", + "description": [ + "\nReturned by {@link OverlayStart} methods for closing a mounted overlay." + ], + "path": "src/core/public/overlays/types.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.typeToNamespacesMap", + "id": "def-public.OverlayRef.onClose", "type": "Object", "tags": [], - "label": "typeToNamespacesMap", - "description": [ - "\nThis map defines each type to search for, and the namespace(s) to search for the type in; this is only intended to be used by a saved\nobject client wrapper.\nIf this is defined, it supersedes the `type` and `namespaces` fields when building the Elasticsearch query.\nAny types that are not included in this map will be excluded entirely.\nIf a type is included but its value is undefined, the operation will search for that type in the Default namespace." - ], - "signature": [ - "Map | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.preference", - "type": "string", - "tags": [], - "label": "preference", + "label": "onClose", "description": [ - "An optional ES preference value to be used for the query" + "\nA Promise that will resolve once this overlay is closed.\n\nOverlays can close from user interaction, calling `close()` on the overlay\nreference or another overlay replacing yours via `openModal` or `openFlyout`." ], "signature": [ - "string | undefined" + "Promise" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "src/core/public/overlays/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.pit", - "type": "Object", + "id": "def-public.OverlayRef.close", + "type": "Function", "tags": [], - "label": "pit", + "label": "close", "description": [ - "\nSearch against a specific Point In Time (PIT) that you've opened with {@link SavedObjectsClient.openPointInTimeForType}." + "\nCloses the referenced overlay if it's still open which in turn will\nresolve the `onClose` Promise. If the overlay had already been\nclosed this method does nothing." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsPitParams", - "text": "SavedObjectsPitParams" - }, - " | undefined" + "() => Promise" ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false + "path": "src/core/public/overlays/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptionsReference", + "id": "def-public.OverlayStart", "type": "Interface", "tags": [], - "label": "SavedObjectsFindOptionsReference", + "label": "OverlayStart", "description": [], - "path": "src/core/server/saved_objects/types.ts", + "path": "src/core/public/overlays/overlay_service.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptionsReference.type", - "type": "string", + "id": "def-public.OverlayStart.banners", + "type": "Object", "tags": [], - "label": "type", - "description": [], - "path": "src/core/server/saved_objects/types.ts", + "label": "banners", + "description": [ + "{@link OverlayBannersStart}" + ], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayBannersStart", + "text": "OverlayBannersStart" + } + ], + "path": "src/core/public/overlays/overlay_service.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptionsReference.id", - "type": "string", + "id": "def-public.OverlayStart.openFlyout", + "type": "Function", "tags": [], - "label": "id", - "description": [], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsImportActionRequiredWarning", - "type": "Interface", - "tags": [], - "label": "SavedObjectsImportActionRequiredWarning", - "description": [ - "\nA warning meant to notify that a specific user action is required to finalize the import\nof some type of object.\n" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsImportActionRequiredWarning.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], + "label": "openFlyout", + "description": [ + "{@link OverlayFlyoutStart#open}" + ], "signature": [ - "\"action_required\"" + "(mount: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayFlyoutOpenOptions", + "text": "OverlayFlyoutOpenOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayRef", + "text": "OverlayRef" + } ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false + "path": "src/core/public/overlays/overlay_service.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.OverlayStart.openFlyout.$1", + "type": "Function", + "tags": [], + "label": "mount", + "description": [], + "signature": [ + "(element: HTMLElement) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.UnmountCallback", + "text": "UnmountCallback" + } + ], + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.OverlayStart.openFlyout.$1.$1", + "type": "Uncategorized", + "tags": [], + "label": "element", + "description": [], + "signature": [ + "T" + ], + "path": "src/core/public/types.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "core", + "id": "def-public.OverlayStart.openFlyout.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayFlyoutOpenOptions", + "text": "OverlayFlyoutOpenOptions" + }, + " | undefined" + ], + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "deprecated": false + } + ] }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportActionRequiredWarning.message", - "type": "string", + "id": "def-public.OverlayStart.openModal", + "type": "Function", "tags": [], - "label": "message", + "label": "openModal", "description": [ - "The translated message to display to the user." + "{@link OverlayModalStart#open}" ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsImportActionRequiredWarning.actionPath", - "type": "string", - "tags": [], - "label": "actionPath", - "description": [ - "The path (without the basePath) that the user should be redirect to address this warning." + "signature": [ + "(mount: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayModalOpenOptions", + "text": "OverlayModalOpenOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayRef", + "text": "OverlayRef" + } ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false + "path": "src/core/public/overlays/overlay_service.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.OverlayStart.openModal.$1", + "type": "Function", + "tags": [], + "label": "mount", + "description": [], + "signature": [ + "(element: HTMLElement) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.UnmountCallback", + "text": "UnmountCallback" + } + ], + "path": "src/core/public/overlays/modal/modal_service.tsx", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.OverlayStart.openModal.$1.$1", + "type": "Uncategorized", + "tags": [], + "label": "element", + "description": [], + "signature": [ + "T" + ], + "path": "src/core/public/types.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "core", + "id": "def-public.OverlayStart.openModal.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayModalOpenOptions", + "text": "OverlayModalOpenOptions" + }, + " | undefined" + ], + "path": "src/core/public/overlays/modal/modal_service.tsx", + "deprecated": false + } + ] }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportActionRequiredWarning.buttonLabel", - "type": "string", + "id": "def-public.OverlayStart.openConfirm", + "type": "Function", "tags": [], - "label": "buttonLabel", + "label": "openConfirm", "description": [ - "An optional label to use for the link button. If unspecified, a default label will be used." + "{@link OverlayModalStart#openConfirm}" ], "signature": [ - "string | undefined" + "(message: string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayModalConfirmOptions", + "text": "OverlayModalConfirmOptions" + }, + " | undefined) => Promise" ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsImportAmbiguousConflictError", - "type": "Interface", - "tags": [], - "label": "SavedObjectsImportAmbiguousConflictError", - "description": [ - "\nRepresents a failure to import due to a conflict, which can be resolved in different ways with an overwrite." - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsImportAmbiguousConflictError.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"ambiguous_conflict\"" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsImportAmbiguousConflictError.destinations", - "type": "Array", - "tags": [], - "label": "destinations", - "description": [], - "signature": [ - "{ id: string; title?: string | undefined; updatedAt?: string | undefined; }[]" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false + "path": "src/core/public/overlays/overlay_service.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.OverlayStart.openConfirm.$1", + "type": "CompoundType", + "tags": [], + "label": "message", + "description": [], + "signature": [ + "string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + "" + ], + "path": "src/core/public/overlays/modal/modal_service.tsx", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.OverlayStart.openConfirm.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayModalConfirmOptions", + "text": "OverlayModalConfirmOptions" + }, + " | undefined" + ], + "path": "src/core/public/overlays/modal/modal_service.tsx", + "deprecated": false + } + ] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportConflictError", + "id": "def-public.PackageInfo", "type": "Interface", "tags": [], - "label": "SavedObjectsImportConflictError", - "description": [ - "\nRepresents a failure to import due to a conflict." - ], - "path": "src/core/server/saved_objects/import/types.ts", + "label": "PackageInfo", + "description": [], + "path": "node_modules/@types/kbn__config/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportConflictError.type", + "id": "def-public.PackageInfo.version", "type": "string", "tags": [], - "label": "type", + "label": "version", "description": [], - "signature": [ - "\"conflict\"" - ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__config/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportConflictError.destinationId", - "type": "string", - "tags": [], - "label": "destinationId", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsImportFailure", - "type": "Interface", - "tags": [], - "label": "SavedObjectsImportFailure", - "description": [ - "\nRepresents a failure to import." - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsImportFailure.id", + "id": "def-public.PackageInfo.branch", "type": "string", "tags": [], - "label": "id", + "label": "branch", "description": [], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__config/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportFailure.type", - "type": "string", + "id": "def-public.PackageInfo.buildNum", + "type": "number", "tags": [], - "label": "type", + "label": "buildNum", "description": [], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__config/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportFailure.meta", - "type": "Object", + "id": "def-public.PackageInfo.buildSha", + "type": "string", "tags": [], - "label": "meta", + "label": "buildSha", "description": [], - "signature": [ - "{ title?: string | undefined; icon?: string | undefined; }" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsImportFailure.overwrite", - "type": "CompoundType", - "tags": [], - "label": "overwrite", - "description": [ - "\nIf `overwrite` is specified, an attempt was made to overwrite an existing object." - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__config/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportFailure.error", - "type": "CompoundType", + "id": "def-public.PackageInfo.dist", + "type": "boolean", "tags": [], - "label": "error", + "label": "dist", "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportConflictError", - "text": "SavedObjectsImportConflictError" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportAmbiguousConflictError", - "text": "SavedObjectsImportAmbiguousConflictError" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportUnsupportedTypeError", - "text": "SavedObjectsImportUnsupportedTypeError" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportMissingReferencesError", - "text": "SavedObjectsImportMissingReferencesError" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportUnknownError", - "text": "SavedObjectsImportUnknownError" - } - ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__config/index.d.ts", "deprecated": false } ], @@ -6320,135 +6547,272 @@ }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportMissingReferencesError", + "id": "def-public.Plugin", "type": "Interface", "tags": [], - "label": "SavedObjectsImportMissingReferencesError", + "label": "Plugin", "description": [ - "\nRepresents a failure to import due to missing references." + "\nThe interface that should be returned by a `PluginInitializer`.\n" ], - "path": "src/core/server/saved_objects/import/types.ts", + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Plugin", + "text": "Plugin" + }, + "" + ], + "path": "src/core/public/plugins/plugin.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportMissingReferencesError.type", - "type": "string", + "id": "def-public.Plugin.setup", + "type": "Function", "tags": [], - "label": "type", + "label": "setup", "description": [], "signature": [ - "\"missing_references\"" + "(core: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreSetup", + "text": "CoreSetup" + }, + ", plugins: TPluginsSetup) => TSetup" ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, + "path": "src/core/public/plugins/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.Plugin.setup.$1", + "type": "Object", + "tags": [], + "label": "core", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreSetup", + "text": "CoreSetup" + }, + "" + ], + "path": "src/core/public/plugins/plugin.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.Plugin.setup.$2", + "type": "Uncategorized", + "tags": [], + "label": "plugins", + "description": [], + "signature": [ + "TPluginsSetup" + ], + "path": "src/core/public/plugins/plugin.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportMissingReferencesError.references", - "type": "Array", + "id": "def-public.Plugin.start", + "type": "Function", "tags": [], - "label": "references", + "label": "start", "description": [], "signature": [ - "{ type: string; id: string; }[]" + "(core: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + }, + ", plugins: TPluginsStart) => TStart" ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false + "path": "src/core/public/plugins/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.Plugin.start.$1", + "type": "Object", + "tags": [], + "label": "core", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + } + ], + "path": "src/core/public/plugins/plugin.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.Plugin.start.$2", + "type": "Uncategorized", + "tags": [], + "label": "plugins", + "description": [], + "signature": [ + "TPluginsStart" + ], + "path": "src/core/public/plugins/plugin.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-public.Plugin.stop", + "type": "Function", + "tags": [], + "label": "stop", + "description": [], + "signature": [ + "(() => void) | undefined" + ], + "path": "src/core/public/plugins/plugin.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportResponse", + "id": "def-public.PluginInitializerContext", "type": "Interface", "tags": [], - "label": "SavedObjectsImportResponse", + "label": "PluginInitializerContext", "description": [ - "\nThe response describing the result of an import." + "\nThe available core services passed to a `PluginInitializer`\n" ], - "path": "src/core/server/saved_objects/import/types.ts", + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.PluginInitializerContext", + "text": "PluginInitializerContext" + }, + "" + ], + "path": "src/core/public/plugins/plugin_context.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportResponse.success", - "type": "boolean", + "id": "def-public.PluginInitializerContext.opaqueId", + "type": "Uncategorized", "tags": [], - "label": "success", - "description": [], - "path": "src/core/server/saved_objects/import/types.ts", + "label": "opaqueId", + "description": [ + "\nA symbol used to identify this plugin in the system. Needed when registering handlers or context providers." + ], + "signature": [ + "symbol" + ], + "path": "src/core/public/plugins/plugin_context.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportResponse.successCount", - "type": "number", + "id": "def-public.PluginInitializerContext.env", + "type": "Object", "tags": [], - "label": "successCount", + "label": "env", "description": [], - "path": "src/core/server/saved_objects/import/types.ts", + "signature": [ + "{ mode: Readonly<", + "EnvironmentMode", + ">; packageInfo: Readonly<", + "PackageInfo", + ">; }" + ], + "path": "src/core/public/plugins/plugin_context.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportResponse.successResults", - "type": "Array", + "id": "def-public.PluginInitializerContext.config", + "type": "Object", "tags": [], - "label": "successResults", + "label": "config", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportSuccess", - "text": "SavedObjectsImportSuccess" - }, - "[] | undefined" + "{ get: () => T; }" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/public/plugins/plugin_context.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.ResponseErrorBody", + "type": "Interface", + "tags": [], + "label": "ResponseErrorBody", + "description": [], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.ResponseErrorBody.message", + "type": "string", + "tags": [], + "label": "message", + "description": [], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportResponse.warnings", - "type": "Array", + "id": "def-public.ResponseErrorBody.statusCode", + "type": "number", "tags": [], - "label": "warnings", + "label": "statusCode", "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportWarning", - "text": "SavedObjectsImportWarning" - }, - "[]" - ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportResponse.errors", - "type": "Array", + "id": "def-public.ResponseErrorBody.attributes", + "type": "Object", "tags": [], - "label": "errors", + "label": "attributes", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportFailure", - "text": "SavedObjectsImportFailure" - }, - "[] | undefined" + "Record | undefined" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false } ], @@ -6456,142 +6820,176 @@ }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportRetry", + "id": "def-public.SavedObject", "type": "Interface", "tags": [], - "label": "SavedObjectsImportRetry", - "description": [ - "\nDescribes a retry operation for importing a saved object." + "label": "SavedObject", + "description": [], + "signature": [ + "SavedObject", + "" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportRetry.type", + "id": "def-public.SavedObject.id", "type": "string", "tags": [], - "label": "type", - "description": [], - "path": "src/core/server/saved_objects/import/types.ts", + "label": "id", + "description": [ + "The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`" + ], + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportRetry.id", + "id": "def-public.SavedObject.type", "type": "string", "tags": [], - "label": "id", - "description": [], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, + "label": "type", + "description": [ + " The type of Saved Object. Each plugin can define it's own custom Saved Object types." + ], + "path": "src/core/types/saved_objects.ts", + "deprecated": false + }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportRetry.overwrite", - "type": "boolean", + "id": "def-public.SavedObject.version", + "type": "string", "tags": [], - "label": "overwrite", - "description": [], - "path": "src/core/server/saved_objects/import/types.ts", + "label": "version", + "description": [ + "An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control." + ], + "signature": [ + "string | undefined" + ], + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportRetry.destinationId", + "id": "def-public.SavedObject.updated_at", "type": "string", "tags": [], - "label": "destinationId", + "label": "updated_at", "description": [ - "\nThe object ID that will be created or overwritten. If not specified, the `id` field will be used." + "Timestamp of the last time this document had been updated." ], "signature": [ "string | undefined" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportRetry.replaceReferences", - "type": "Array", + "id": "def-public.SavedObject.error", + "type": "Object", "tags": [], - "label": "replaceReferences", + "label": "error", "description": [], "signature": [ - "{ type: string; from: string; to: string; }[]" + "SavedObjectError", + " | undefined" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportRetry.createNewCopy", - "type": "CompoundType", + "id": "def-public.SavedObject.attributes", + "type": "Uncategorized", "tags": [], - "label": "createNewCopy", + "label": "attributes", "description": [ - "\nIf `createNewCopy` is specified, the new object has a new (undefined) origin ID. This is only needed for the case where\n`createNewCopies` mode is disabled and ambiguous source conflicts are detected." + "{@inheritdoc SavedObjectAttributes}" ], "signature": [ - "boolean | undefined" + "T" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportRetry.ignoreMissingReferences", - "type": "CompoundType", + "id": "def-public.SavedObject.references", + "type": "Array", "tags": [], - "label": "ignoreMissingReferences", + "label": "references", "description": [ - "\nIf `ignoreMissingReferences` is specified, reference validation will be skipped for this object." + "{@inheritdoc SavedObjectReference}" ], "signature": [ - "boolean | undefined" + "SavedObjectReference", + "[]" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsImportSimpleWarning", - "type": "Interface", - "tags": [], - "label": "SavedObjectsImportSimpleWarning", - "description": [ - "\nA simple informative warning that will be displayed to the user.\n" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportSimpleWarning.type", + "id": "def-public.SavedObject.migrationVersion", + "type": "Object", + "tags": [], + "label": "migrationVersion", + "description": [ + "{@inheritdoc SavedObjectsMigrationVersion}" + ], + "signature": [ + "SavedObjectsMigrationVersion", + " | undefined" + ], + "path": "src/core/types/saved_objects.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObject.coreMigrationVersion", "type": "string", "tags": [], - "label": "type", - "description": [], + "label": "coreMigrationVersion", + "description": [ + "A semver value that is used when upgrading objects between Kibana versions." + ], "signature": [ - "\"simple\"" + "string | undefined" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportSimpleWarning.message", + "id": "def-public.SavedObject.namespaces", + "type": "Array", + "tags": [], + "label": "namespaces", + "description": [ + "\nSpace(s) that this saved object exists in. This attribute is not used for \"global\" saved object types which are registered with\n`namespaceType: 'agnostic'`." + ], + "signature": [ + "string[] | undefined" + ], + "path": "src/core/types/saved_objects.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObject.originId", "type": "string", "tags": [], - "label": "message", + "label": "originId", "description": [ - "The translated message to display to the user" + "\nThe ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration\nfrom a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import\nto ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given\nspace." ], - "path": "src/core/server/saved_objects/import/types.ts", + "signature": [ + "string | undefined" + ], + "path": "src/core/types/saved_objects.ts", "deprecated": false } ], @@ -6599,102 +6997,84 @@ }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportSuccess", + "id": "def-public.SavedObjectAttributes", "type": "Interface", "tags": [], - "label": "SavedObjectsImportSuccess", + "label": "SavedObjectAttributes", "description": [ - "\nRepresents a successful import." + "\nThe data for a Saved Object is stored as an object in the `attributes`\nproperty.\n" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportSuccess.id", - "type": "string", + "id": "def-public.SavedObjectAttributes.Unnamed", + "type": "IndexSignature", "tags": [], - "label": "id", + "label": "[key: string]: SavedObjectAttribute", "description": [], - "path": "src/core/server/saved_objects/import/types.ts", + "signature": [ + "[key: string]: ", + "SavedObjectAttribute" + ], + "path": "src/core/types/saved_objects.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectError", + "type": "Interface", + "tags": [], + "label": "SavedObjectError", + "description": [], + "path": "src/core/types/saved_objects.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportSuccess.type", + "id": "def-public.SavedObjectError.error", "type": "string", "tags": [], - "label": "type", + "label": "error", "description": [], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportSuccess.destinationId", + "id": "def-public.SavedObjectError.message", "type": "string", "tags": [], - "label": "destinationId", - "description": [ - "\nIf `destinationId` is specified, the new object has a new ID that is different from the import ID." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsImportSuccess.createNewCopy", - "type": "CompoundType", - "tags": [ - "deprecated" - ], - "label": "createNewCopy", + "label": "message", "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": true, - "references": [ - { - "plugin": "spaces", - "path": "x-pack/plugins/spaces/public/copy_saved_objects_to_space/components/copy_to_space_flyout_internal.tsx" - }, - { - "plugin": "savedObjectsManagement", - "path": "src/plugins/saved_objects_management/public/lib/resolve_import_errors.ts" - } - ] + "path": "src/core/types/saved_objects.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportSuccess.meta", - "type": "Object", + "id": "def-public.SavedObjectError.statusCode", + "type": "number", "tags": [], - "label": "meta", + "label": "statusCode", "description": [], - "signature": [ - "{ title?: string | undefined; icon?: string | undefined; }" - ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportSuccess.overwrite", - "type": "CompoundType", + "id": "def-public.SavedObjectError.metadata", + "type": "Object", "tags": [], - "label": "overwrite", - "description": [ - "\nIf `overwrite` is specified, this object overwrote an existing one (or will do so, in the case of a pending resolution)." - ], + "label": "metadata", + "description": [], "signature": [ - "boolean | undefined" + "Record | undefined" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false } ], @@ -6702,47 +7082,44 @@ }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportUnknownError", + "id": "def-public.SavedObjectReference", "type": "Interface", "tags": [], - "label": "SavedObjectsImportUnknownError", + "label": "SavedObjectReference", "description": [ - "\nRepresents a failure to import due to an unknown reason." + "\nA reference to another saved object.\n" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportUnknownError.type", + "id": "def-public.SavedObjectReference.name", "type": "string", "tags": [], - "label": "type", + "label": "name", "description": [], - "signature": [ - "\"unknown\"" - ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportUnknownError.message", + "id": "def-public.SavedObjectReference.type", "type": "string", "tags": [], - "label": "message", + "label": "type", "description": [], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportUnknownError.statusCode", - "type": "number", + "id": "def-public.SavedObjectReference.id", + "type": "string", "tags": [], - "label": "statusCode", + "label": "id", "description": [], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false } ], @@ -6750,141 +7127,128 @@ }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportUnsupportedTypeError", + "id": "def-public.SavedObjectReferenceWithContext", "type": "Interface", "tags": [], - "label": "SavedObjectsImportUnsupportedTypeError", + "label": "SavedObjectReferenceWithContext", "description": [ - "\nRepresents a failure to import due to having an unsupported saved object type." + "\nA returned input object or one of its references, with additional context.\n" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportUnsupportedTypeError.type", + "id": "def-public.SavedObjectReferenceWithContext.type", "type": "string", "tags": [], "label": "type", - "description": [], - "signature": [ - "\"unsupported_type\"" + "description": [ + "The type of the referenced object" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsMigrationVersion", - "type": "Interface", - "tags": [], - "label": "SavedObjectsMigrationVersion", - "description": [ - "\nInformation about the migrations that have been applied to this SavedObject.\nWhen Kibana starts up, KibanaMigrator detects outdated documents and\nmigrates them based on this value. For each migration that has been applied,\nthe plugin's name is used as a key and the latest migration version as the\nvalue.\n" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsMigrationVersion.Unnamed", - "type": "IndexSignature", + "id": "def-public.SavedObjectReferenceWithContext.id", + "type": "string", "tags": [], - "label": "[pluginName: string]: string", - "description": [], + "label": "id", + "description": [ + "The ID of the referenced object" + ], + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectReferenceWithContext.originId", + "type": "string", + "tags": [], + "label": "originId", + "description": [ + "The origin ID of the referenced object (if it has one)" + ], "signature": [ - "[pluginName: string]: string" + "string | undefined" ], - "path": "src/core/types/saved_objects.ts", + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsResolveResponse", - "type": "Interface", - "tags": [], - "label": "SavedObjectsResolveResponse", - "description": [ - "\n" - ], - "signature": [ + }, { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsResolveResponse", - "text": "SavedObjectsResolveResponse" + "parentPluginId": "core", + "id": "def-public.SavedObjectReferenceWithContext.spaces", + "type": "Array", + "tags": [], + "label": "spaces", + "description": [ + "The space(s) that the referenced object exists in" + ], + "signature": [ + "string[]" + ], + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "deprecated": false }, - "" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsResolveResponse.saved_object", - "type": "Object", + "id": "def-public.SavedObjectReferenceWithContext.inboundReferences", + "type": "Array", "tags": [], - "label": "saved_object", + "label": "inboundReferences", "description": [ - "\nThe saved object that was found." + "\nReferences to this object; note that this does not contain _all inbound references everywhere for this object_, it only contains\ninbound references for the scope of this operation" ], "signature": [ - "SavedObject", - "" + "{ type: string; id: string; name: string; }[]" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsResolveResponse.outcome", + "id": "def-public.SavedObjectReferenceWithContext.isMissing", "type": "CompoundType", "tags": [], - "label": "outcome", + "label": "isMissing", "description": [ - "\nThe outcome for a successful `resolve` call is one of the following values:\n\n * `'exactMatch'` -- One document exactly matched the given ID.\n * `'aliasMatch'` -- One document with a legacy URL alias matched the given ID; in this case the `saved_object.id` field is different\n than the given ID.\n * `'conflict'` -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the\n `saved_object` object is the exact match, and the `saved_object.id` field is the same as the given ID." + "Whether or not this object or reference is missing" ], "signature": [ - "\"exactMatch\" | \"aliasMatch\" | \"conflict\"" + "boolean | undefined" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsResolveResponse.alias_target_id", - "type": "string", + "id": "def-public.SavedObjectReferenceWithContext.spacesWithMatchingAliases", + "type": "Array", "tags": [], - "label": "alias_target_id", + "label": "spacesWithMatchingAliases", "description": [ - "\nThe ID of the object that the legacy URL alias points to.\n\n**Note:** this field is *only* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`)." + "The space(s) that legacy URL aliases matching this type/id exist in" ], "signature": [ - "string | undefined" + "string[] | undefined" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsResolveResponse.alias_purpose", - "type": "CompoundType", + "id": "def-public.SavedObjectReferenceWithContext.spacesWithMatchingOrigins", + "type": "Array", "tags": [], - "label": "alias_purpose", + "label": "spacesWithMatchingOrigins", "description": [ - "\nThe reason this alias was created.\n\nCurrently this is used to determine whether or not a toast should be shown when a user is redirected from a legacy URL; if the alias\nwas created because of saved object conversion, then we will display a toast telling the user that the object has a new URL.\n\n**Note:** this field is *only* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`)." + "The space(s) that objects matching this origin exist in (including this one)" ], "signature": [ - "\"savedObjectConversion\" | \"savedObjectImport\" | undefined" + "string[] | undefined" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", "deprecated": false } ], @@ -6892,187 +7256,64 @@ }, { "parentPluginId": "core", - "id": "def-public.ShipperClassConstructor", + "id": "def-public.SavedObjectsBaseOptions", "type": "Interface", "tags": [], - "label": "ShipperClassConstructor", + "label": "SavedObjectsBaseOptions", "description": [ - "\nConstructor of a {@link IShipper}" - ], - "signature": [ - "ShipperClassConstructor", - "" + "\n" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.ShipperClassConstructor.shipperName", + "id": "def-public.SavedObjectsBaseOptions.namespace", "type": "string", "tags": [], - "label": "shipperName", - "description": [ - "\nThe shipper's unique name" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.ShipperClassConstructor.new", - "type": "Function", - "tags": [], - "label": "new", + "label": "namespace", "description": [ - "\nThe constructor" + "Specify the namespace for this operation" ], "signature": [ - "any" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.ShipperClassConstructor.new.$1", - "type": "Uncategorized", - "tags": [], - "label": "config", - "description": [ - "The shipper's custom config" - ], - "signature": [ - "Config" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-public.ShipperClassConstructor.new.$2", - "type": "Object", - "tags": [], - "label": "initContext", - "description": [ - "Common context {@link AnalyticsClientInitContext }" - ], - "signature": [ - "AnalyticsClientInitContext" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "isRequired": true - } + "string | undefined" ], - "returnComment": [] + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.TelemetryCounter", + "id": "def-public.SavedObjectsBulkResolveObject", "type": "Interface", "tags": [], - "label": "TelemetryCounter", + "label": "SavedObjectsBulkResolveObject", "description": [ - "\nShape of the events emitted by the telemetryCounter$ observable" + "\n" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.TelemetryCounter.type", - "type": "CompoundType", + "id": "def-public.SavedObjectsBulkResolveObject.id", + "type": "string", "tags": [], - "label": "type", - "description": [ - "\n{@link TelemetryCounterType}" - ], - "signature": [ - "\"failed\" | \"enqueued\" | \"sent_to_shipper\" | \"succeeded\" | \"dropped\"" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "label": "id", + "description": [], + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.TelemetryCounter.source", - "type": "string", - "tags": [], - "label": "source", - "description": [ - "\nWho emitted the event? It can be \"client\" or the name of the shipper." - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.TelemetryCounter.event_type", - "type": "string", - "tags": [], - "label": "event_type", - "description": [ - "\nThe event type the success/failure/drop event refers to." - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.TelemetryCounter.code", + "id": "def-public.SavedObjectsBulkResolveObject.type", "type": "string", "tags": [], - "label": "code", - "description": [ - "\nCode to provide additional information about the success or failure. Examples are 200/400/504/ValidationError/UnknownError" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.TelemetryCounter.count", - "type": "number", - "tags": [], - "label": "count", - "description": [ - "\nThe number of events that this counter refers to." - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.ThemeServiceSetup", - "type": "Interface", - "tags": [], - "label": "ThemeServiceSetup", - "description": [], - "path": "node_modules/@types/kbn__core-theme-browser/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.ThemeServiceSetup.theme$", - "type": "Object", - "tags": [], - "label": "theme$", + "label": "type", "description": [], - "signature": [ - "Observable", - "<", - "CoreTheme", - ">" - ], - "path": "node_modules/@types/kbn__core-theme-browser/index.d.ts", + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "deprecated": false } ], @@ -7080,28 +7321,34 @@ }, { "parentPluginId": "core", - "id": "def-public.ThemeServiceStart", + "id": "def-public.SavedObjectsCollectMultiNamespaceReferencesResponse", "type": "Interface", "tags": [], - "label": "ThemeServiceStart", - "description": [], - "path": "node_modules/@types/kbn__core-theme-browser/index.d.ts", + "label": "SavedObjectsCollectMultiNamespaceReferencesResponse", + "description": [ + "\nThe response when object references are collected.\n" + ], + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.ThemeServiceStart.theme$", - "type": "Object", + "id": "def-public.SavedObjectsCollectMultiNamespaceReferencesResponse.objects", + "type": "Array", "tags": [], - "label": "theme$", + "label": "objects", "description": [], "signature": [ - "Observable", - "<", - "CoreTheme", - ">" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectReferenceWithContext", + "text": "SavedObjectReferenceWithContext" + }, + "[]" ], - "path": "node_modules/@types/kbn__core-theme-browser/index.d.ts", + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", "deprecated": false } ], @@ -7109,309 +7356,345 @@ }, { "parentPluginId": "core", - "id": "def-public.ToastOptions", + "id": "def-public.SavedObjectsFindOptions", "type": "Interface", "tags": [], - "label": "ToastOptions", + "label": "SavedObjectsFindOptions", "description": [ - "\nOptions available for {@link IToasts} APIs." + "\n" ], - "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.ToastOptions.toastLifeTimeMs", - "type": "number", + "id": "def-public.SavedObjectsFindOptions.type", + "type": "CompoundType", "tags": [], - "label": "toastLifeTimeMs", - "description": [ - "\nHow long should the toast remain on screen." - ], + "label": "type", + "description": [], "signature": [ - "number | undefined" + "string | string[]" ], - "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.UiSettingsParams", - "type": "Interface", - "tags": [], - "label": "UiSettingsParams", - "description": [ - "\nUiSettings parameters defined by the plugins." - ], - "signature": [ - "UiSettingsParams", - "" - ], - "path": "src/core/types/ui_settings.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.name", - "type": "string", + "id": "def-public.SavedObjectsFindOptions.page", + "type": "number", "tags": [], - "label": "name", - "description": [ - "title in the UI" - ], + "label": "page", + "description": [], "signature": [ - "string | undefined" + "number | undefined" ], - "path": "src/core/types/ui_settings.ts", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.value", - "type": "Uncategorized", + "id": "def-public.SavedObjectsFindOptions.perPage", + "type": "number", "tags": [], - "label": "value", - "description": [ - "default value to fall back to if a user doesn't provide any" - ], + "label": "perPage", + "description": [], "signature": [ - "T | undefined" + "number | undefined" ], - "path": "src/core/types/ui_settings.ts", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.description", + "id": "def-public.SavedObjectsFindOptions.sortField", "type": "string", "tags": [], - "label": "description", - "description": [ - "description provided to a user in UI" - ], + "label": "sortField", + "description": [], "signature": [ "string | undefined" ], - "path": "src/core/types/ui_settings.ts", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.category", - "type": "Array", + "id": "def-public.SavedObjectsFindOptions.sortOrder", + "type": "CompoundType", "tags": [], - "label": "category", - "description": [ - "used to group the configured setting in the UI" - ], + "label": "sortOrder", + "description": [], "signature": [ - "string[] | undefined" + "SortOrder", + " | undefined" ], - "path": "src/core/types/ui_settings.ts", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.options", + "id": "def-public.SavedObjectsFindOptions.fields", "type": "Array", "tags": [], - "label": "options", + "label": "fields", "description": [ - "array of permitted values for this setting" + "\nAn array of fields to include in the results" ], "signature": [ "string[] | undefined" ], - "path": "src/core/types/ui_settings.ts", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.optionLabels", - "type": "Object", + "id": "def-public.SavedObjectsFindOptions.search", + "type": "string", "tags": [], - "label": "optionLabels", + "label": "search", "description": [ - "text labels for 'select' type UI element" + "Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String `query` argument for more information" ], "signature": [ - "Record | undefined" + "string | undefined" ], - "path": "src/core/types/ui_settings.ts", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.requiresPageReload", - "type": "CompoundType", + "id": "def-public.SavedObjectsFindOptions.searchFields", + "type": "Array", "tags": [], - "label": "requiresPageReload", + "label": "searchFields", "description": [ - "a flag indicating whether new value applying requires page reloading" + "The fields to perform the parsed query against. See Elasticsearch Simple Query String `fields` argument for more information" ], "signature": [ - "boolean | undefined" + "string[] | undefined" ], - "path": "src/core/types/ui_settings.ts", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.readonly", - "type": "CompoundType", + "id": "def-public.SavedObjectsFindOptions.searchAfter", + "type": "Array", "tags": [], - "label": "readonly", + "label": "searchAfter", "description": [ - "a flag indicating that value cannot be changed" + "\nUse the sort values from the previous page to retrieve the next page of results." ], "signature": [ - "boolean | undefined" + "string[] | undefined" ], - "path": "src/core/types/ui_settings.ts", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.sensitive", - "type": "CompoundType", + "id": "def-public.SavedObjectsFindOptions.rootSearchFields", + "type": "Array", "tags": [], - "label": "sensitive", + "label": "rootSearchFields", "description": [ - "\na flag indicating that value might contain user sensitive data.\nused by telemetry to mask the value of the setting when sent." + "\nThe fields to perform the parsed query against. Unlike the `searchFields` argument, these are expected to be root fields and will not\nbe modified. If used in conjunction with `searchFields`, both are concatenated together." ], "signature": [ - "boolean | undefined" + "string[] | undefined" ], - "path": "src/core/types/ui_settings.ts", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.type", + "id": "def-public.SavedObjectsFindOptions.hasReference", "type": "CompoundType", "tags": [], - "label": "type", + "label": "hasReference", "description": [ - "defines a type of UI element {@link UiSettingsType}" + "\nSearch for documents having a reference to the specified objects.\nUse `hasReferenceOperator` to specify the operator to use when searching for multiple references." ], "signature": [ - "UiSettingsType", - " | undefined" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptionsReference", + "text": "SavedObjectsFindOptionsReference" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptionsReference", + "text": "SavedObjectsFindOptionsReference" + }, + "[] | undefined" ], - "path": "src/core/types/ui_settings.ts", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.deprecation", - "type": "Object", + "id": "def-public.SavedObjectsFindOptions.hasReferenceOperator", + "type": "CompoundType", "tags": [], - "label": "deprecation", + "label": "hasReferenceOperator", "description": [ - "optional deprecation information. Used to generate a deprecation warning." + "\nThe operator to use when searching by multiple references using the `hasReference` option. Defaults to `OR`" ], "signature": [ - "DeprecationSettings", - " | undefined" + "\"AND\" | \"OR\" | undefined" ], - "path": "src/core/types/ui_settings.ts", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.order", - "type": "number", + "id": "def-public.SavedObjectsFindOptions.defaultSearchOperator", + "type": "CompoundType", "tags": [], - "label": "order", + "label": "defaultSearchOperator", "description": [ - "\nindex of the settings within its category (ascending order, smallest will be displayed first).\nUsed for ordering in the UI.\n" + "\nThe search operator to use with the provided filter. Defaults to `OR`" ], "signature": [ - "number | undefined" + "\"AND\" | \"OR\" | undefined" ], - "path": "src/core/types/ui_settings.ts", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.schema", - "type": "Object", + "id": "def-public.SavedObjectsFindOptions.filter", + "type": "Any", "tags": [], - "label": "schema", + "label": "filter", "description": [], "signature": [ - "Type", - "" + "any" ], - "path": "src/core/types/ui_settings.ts", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.metric", + "id": "def-public.SavedObjectsFindOptions.aggs", "type": "Object", "tags": [ - "deprecated" + "alpha" ], - "label": "metric", + "label": "aggs", "description": [ - "\nMetric to track once this property changes" + "\nA record of aggregations to perform.\nThe API currently only supports a limited set of metrics and bucket aggregation types.\nAdditional aggregation types can be contributed to Core.\n" ], "signature": [ - "{ type: string; name: string; } | undefined" + "Record | undefined" ], - "path": "src/core/types/ui_settings.ts", - "deprecated": true, - "references": [ - { - "plugin": "advancedSettings", - "path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/server/ui_settings.ts" - }, + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsFindOptions.namespaces", + "type": "Array", + "tags": [], + "label": "namespaces", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsFindOptions.typeToNamespacesMap", + "type": "Object", + "tags": [], + "label": "typeToNamespacesMap", + "description": [ + "\nThis map defines each type to search for, and the namespace(s) to search for the type in; this is only intended to be used by a saved\nobject client wrapper.\nIf this is defined, it supersedes the `type` and `namespaces` fields when building the Elasticsearch query.\nAny types that are not included in this map will be excluded entirely.\nIf a type is included but its value is undefined, the operation will search for that type in the Default namespace." + ], + "signature": [ + "Map | undefined" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsFindOptions.preference", + "type": "string", + "tags": [], + "label": "preference", + "description": [ + "An optional ES preference value to be used for the query" + ], + "signature": [ + "string | undefined" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsFindOptions.pit", + "type": "Object", + "tags": [], + "label": "pit", + "description": [ + "\nSearch against a specific Point In Time (PIT) that you've opened with {@link SavedObjectsClient.openPointInTimeForType}." + ], + "signature": [ { - "plugin": "discover", - "path": "src/plugins/discover/server/ui_settings.ts" + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsPitParams", + "text": "SavedObjectsPitParams" }, - { - "plugin": "discover", - "path": "src/plugins/discover/server/ui_settings.ts" - } - ] + " | undefined" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsState", + "id": "def-public.SavedObjectsFindOptionsReference", "type": "Interface", "tags": [], - "label": "UiSettingsState", + "label": "SavedObjectsFindOptionsReference", "description": [], - "path": "src/core/public/ui_settings/types.ts", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.UiSettingsState.Unnamed", - "type": "IndexSignature", + "id": "def-public.SavedObjectsFindOptionsReference.type", + "type": "string", "tags": [], - "label": "[key: string]: PublicUiSettingsParams & UserProvidedValues", + "label": "type", "description": [], - "signature": [ - "[key: string]: ", - "PublicUiSettingsParams", - " & ", - "UserProvidedValues", - "" - ], - "path": "src/core/public/ui_settings/types.ts", + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsFindOptionsReference.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "src/core/server/saved_objects/types.ts", "deprecated": false } ], @@ -7419,913 +7702,1591 @@ }, { "parentPluginId": "core", - "id": "def-public.UserProvidedValues", + "id": "def-public.SavedObjectsImportActionRequiredWarning", "type": "Interface", "tags": [], - "label": "UserProvidedValues", + "label": "SavedObjectsImportActionRequiredWarning", "description": [ - "\nDescribes the values explicitly set by user." - ], - "signature": [ - "UserProvidedValues", - "" + "\nA warning meant to notify that a specific user action is required to finalize the import\nof some type of object.\n" ], - "path": "src/core/types/ui_settings.ts", + "path": "src/core/server/saved_objects/import/types.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.UserProvidedValues.userValue", - "type": "Uncategorized", + "id": "def-public.SavedObjectsImportActionRequiredWarning.type", + "type": "string", "tags": [], - "label": "userValue", + "label": "type", "description": [], "signature": [ - "T | undefined" + "\"action_required\"" ], - "path": "src/core/types/ui_settings.ts", + "path": "src/core/server/saved_objects/import/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.UserProvidedValues.isOverridden", - "type": "CompoundType", + "id": "def-public.SavedObjectsImportActionRequiredWarning.message", + "type": "string", "tags": [], - "label": "isOverridden", - "description": [], + "label": "message", + "description": [ + "The translated message to display to the user." + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportActionRequiredWarning.actionPath", + "type": "string", + "tags": [], + "label": "actionPath", + "description": [ + "The path (without the basePath) that the user should be redirect to address this warning." + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportActionRequiredWarning.buttonLabel", + "type": "string", + "tags": [], + "label": "buttonLabel", + "description": [ + "An optional label to use for the link button. If unspecified, a default label will be used." + ], "signature": [ - "boolean | undefined" + "string | undefined" ], - "path": "src/core/types/ui_settings.ts", + "path": "src/core/server/saved_objects/import/types.ts", "deprecated": false } ], "initialIsOpen": false - } - ], - "enums": [], - "misc": [ + }, { "parentPluginId": "core", - "id": "def-public.AnalyticsServiceSetup", - "type": "Type", + "id": "def-public.SavedObjectsImportAmbiguousConflictError", + "type": "Interface", "tags": [], - "label": "AnalyticsServiceSetup", + "label": "SavedObjectsImportAmbiguousConflictError", "description": [ - "\nExposes the public APIs of the AnalyticsClient during the setup phase.\n{@link AnalyticsClient}" - ], - "signature": [ - "{ optIn: (optInConfig: ", - "OptInConfig", - ") => void; reportEvent: >(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ", - "Observable", - "<", - "TelemetryCounter", - ">; registerEventType: (eventTypeOps: ", - "EventTypeOpts", - ") => void; registerShipper: (Shipper: ", - "ShipperClassConstructor", - ", shipperConfig: ShipperConfig, opts?: ", - "RegisterShipperOpts", - " | undefined) => void; registerContextProvider: (contextProviderOpts: ", - "ContextProviderOpts", - ") => void; removeContextProvider: (contextProviderName: string) => void; }" + "\nRepresents a failure to import due to a conflict, which can be resolved in different ways with an overwrite." ], - "path": "node_modules/@types/kbn__core-analytics-browser/index.d.ts", + "path": "src/core/server/saved_objects/import/types.ts", "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportAmbiguousConflictError.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"ambiguous_conflict\"" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportAmbiguousConflictError.destinations", + "type": "Array", + "tags": [], + "label": "destinations", + "description": [], + "signature": [ + "{ id: string; title?: string | undefined; updatedAt?: string | undefined; }[]" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.AnalyticsServiceStart", - "type": "Type", + "id": "def-public.SavedObjectsImportConflictError", + "type": "Interface", "tags": [], - "label": "AnalyticsServiceStart", + "label": "SavedObjectsImportConflictError", "description": [ - "\nExposes the public APIs of the AnalyticsClient during the start phase\n{@link AnalyticsClient}" - ], - "signature": [ - "{ optIn: (optInConfig: ", - "OptInConfig", - ") => void; reportEvent: >(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ", - "Observable", - "<", - "TelemetryCounter", - ">; }" + "\nRepresents a failure to import due to a conflict." ], - "path": "node_modules/@types/kbn__core-analytics-browser/index.d.ts", + "path": "src/core/server/saved_objects/import/types.ts", "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportConflictError.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"conflict\"" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportConflictError.destinationId", + "type": "string", + "tags": [], + "label": "destinationId", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.APP_WRAPPER_CLASS", - "type": "string", + "id": "def-public.SavedObjectsImportFailure", + "type": "Interface", "tags": [], - "label": "APP_WRAPPER_CLASS", + "label": "SavedObjectsImportFailure", "description": [ - "\nThe class name for top level *and* nested application wrappers to ensure proper layout" - ], - "signature": [ - "\"kbnAppWrapper\"" + "\nRepresents a failure to import." ], - "path": "src/core/utils/app_wrapper_class.ts", + "path": "src/core/server/saved_objects/import/types.ts", "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportFailure.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportFailure.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportFailure.meta", + "type": "Object", + "tags": [], + "label": "meta", + "description": [], + "signature": [ + "{ title?: string | undefined; icon?: string | undefined; }" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportFailure.overwrite", + "type": "CompoundType", + "tags": [], + "label": "overwrite", + "description": [ + "\nIf `overwrite` is specified, an attempt was made to overwrite an existing object." + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportFailure.error", + "type": "CompoundType", + "tags": [], + "label": "error", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportConflictError", + "text": "SavedObjectsImportConflictError" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportAmbiguousConflictError", + "text": "SavedObjectsImportAmbiguousConflictError" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportUnsupportedTypeError", + "text": "SavedObjectsImportUnsupportedTypeError" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportMissingReferencesError", + "text": "SavedObjectsImportMissingReferencesError" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportUnknownError", + "text": "SavedObjectsImportUnknownError" + } + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.EventType", - "type": "Type", + "id": "def-public.SavedObjectsImportMissingReferencesError", + "type": "Interface", "tags": [], - "label": "EventType", + "label": "SavedObjectsImportMissingReferencesError", "description": [ - "\nEvent Type used for indexed structures. Only used to improve the readability of the types" - ], - "signature": [ - "string" + "\nRepresents a failure to import due to missing references." ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "src/core/server/saved_objects/import/types.ts", "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportMissingReferencesError.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"missing_references\"" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportMissingReferencesError.references", + "type": "Array", + "tags": [], + "label": "references", + "description": [], + "signature": [ + "{ type: string; id: string; }[]" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.ExecutionContextStart", - "type": "Type", + "id": "def-public.SavedObjectsImportResponse", + "type": "Interface", "tags": [], - "label": "ExecutionContextStart", + "label": "SavedObjectsImportResponse", "description": [ - "\nSee {@link ExecutionContextSetup}." - ], - "signature": [ - "ExecutionContextSetup" + "\nThe response describing the result of an import." ], - "path": "node_modules/@types/kbn__core-execution-context-browser/index.d.ts", + "path": "src/core/server/saved_objects/import/types.ts", "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.FatalErrorsStart", - "type": "Type", - "tags": [], - "label": "FatalErrorsStart", - "description": [ - "\nFatalErrors stop the Kibana Public Core and displays a fatal error screen\nwith details about the Kibana build and the error.\n" - ], - "signature": [ - "FatalErrorsSetup" + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportResponse.success", + "type": "boolean", + "tags": [], + "label": "success", + "description": [], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportResponse.successCount", + "type": "number", + "tags": [], + "label": "successCount", + "description": [], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportResponse.successResults", + "type": "Array", + "tags": [], + "label": "successResults", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportSuccess", + "text": "SavedObjectsImportSuccess" + }, + "[] | undefined" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportResponse.warnings", + "type": "Array", + "tags": [], + "label": "warnings", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportWarning", + "text": "SavedObjectsImportWarning" + }, + "[]" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportResponse.errors", + "type": "Array", + "tags": [], + "label": "errors", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportFailure", + "text": "SavedObjectsImportFailure" + }, + "[] | undefined" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + } ], - "path": "node_modules/@types/kbn__core-fatal-errors-browser/index.d.ts", - "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.IToasts", - "type": "Type", + "id": "def-public.SavedObjectsImportRetry", + "type": "Interface", "tags": [], - "label": "IToasts", + "label": "SavedObjectsImportRetry", "description": [ - "\nMethods for adding and removing global toast messages. See {@link ToastsApi}." + "\nDescribes a retry operation for importing a saved object." ], - "signature": [ - "{ add: (toastOrTitle: ", + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportRetry.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false }, - ") => ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportRetry.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false }, - "; get$: () => ", - "Observable", - "<", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportRetry.overwrite", + "type": "boolean", + "tags": [], + "label": "overwrite", + "description": [], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false }, - "[]>; remove: (toastOrId: string | ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportRetry.destinationId", + "type": "string", + "tags": [], + "label": "destinationId", + "description": [ + "\nThe object ID that will be created or overwritten. If not specified, the `id` field will be used." + ], + "signature": [ + "string | undefined" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false }, - ") => void; addSuccess: (toastOrTitle: ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportRetry.replaceReferences", + "type": "Array", + "tags": [], + "label": "replaceReferences", + "description": [], + "signature": [ + "{ type: string; from: string; to: string; }[]" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false }, - ", options?: ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastOptions", - "text": "ToastOptions" + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportRetry.createNewCopy", + "type": "CompoundType", + "tags": [], + "label": "createNewCopy", + "description": [ + "\nIf `createNewCopy` is specified, the new object has a new (undefined) origin ID. This is only needed for the case where\n`createNewCopies` mode is disabled and ambiguous source conflicts are detected." + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false }, - " | undefined) => ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; addWarning: (toastOrTitle: ", + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportRetry.ignoreMissingReferences", + "type": "CompoundType", + "tags": [], + "label": "ignoreMissingReferences", + "description": [ + "\nIf `ignoreMissingReferences` is specified, reference validation will be skipped for this object." + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportSimpleWarning", + "type": "Interface", + "tags": [], + "label": "SavedObjectsImportSimpleWarning", + "description": [ + "\nA simple informative warning that will be displayed to the user.\n" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastOptions", - "text": "ToastOptions" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; addDanger: (toastOrTitle: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastOptions", - "text": "ToastOptions" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; addError: (error: Error, options: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ErrorToastOptions", - "text": "ErrorToastOptions" - }, - ") => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; addInfo: (toastOrTitle: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastOptions", - "text": "ToastOptions" + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportSimpleWarning.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"simple\"" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false }, - " | undefined) => ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; }" - ], - "path": "src/core/public/notifications/toasts/toasts_api.tsx", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.KibanaExecutionContext", - "type": "Type", - "tags": [], - "label": "KibanaExecutionContext", - "description": [], - "signature": [ - "{ readonly type?: string | undefined; readonly name?: string | undefined; readonly page?: string | undefined; readonly id?: string | undefined; readonly description?: string | undefined; readonly url?: string | undefined; child?: ", - "KibanaExecutionContext", - " | undefined; }" + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportSimpleWarning.message", + "type": "string", + "tags": [], + "label": "message", + "description": [ + "The translated message to display to the user" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + } ], - "path": "node_modules/@types/kbn__core-execution-context-common/index.d.ts", - "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.MountPoint", - "type": "Type", + "id": "def-public.SavedObjectsImportSuccess", + "type": "Interface", "tags": [], - "label": "MountPoint", + "label": "SavedObjectsImportSuccess", "description": [ - "\nA function that should mount DOM content inside the provided container element\nand return a handler to unmount it.\n" - ], - "signature": [ - "(element: T) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.UnmountCallback", - "text": "UnmountCallback" - } + "\nRepresents a successful import." ], - "path": "src/core/public/types.ts", + "path": "src/core/server/saved_objects/import/types.ts", "deprecated": false, - "returnComment": [ - "a {@link UnmountCallback } that unmount the element on call." - ], "children": [ { "parentPluginId": "core", - "id": "def-public.MountPoint.$1", - "type": "Uncategorized", + "id": "def-public.SavedObjectsImportSuccess.id", + "type": "string", "tags": [], - "label": "element", + "label": "id", + "description": [], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportSuccess.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportSuccess.destinationId", + "type": "string", + "tags": [], + "label": "destinationId", "description": [ - "the container element to render into" + "\nIf `destinationId` is specified, the new object has a new ID that is different from the import ID." ], "signature": [ - "T" + "string | undefined" ], - "path": "src/core/public/types.ts", + "path": "src/core/server/saved_objects/import/types.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.PluginInitializer", - "type": "Type", - "tags": [], - "label": "PluginInitializer", - "description": [ - "\nThe `plugin` export at the root of a plugin's `public` directory should conform\nto this interface.\n" - ], - "signature": [ - "(core: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.PluginInitializerContext", - "text": "PluginInitializerContext" }, - ") => ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Plugin", - "text": "Plugin" + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportSuccess.createNewCopy", + "type": "CompoundType", + "tags": [ + "deprecated" + ], + "label": "createNewCopy", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": true, + "references": [ + { + "plugin": "spaces", + "path": "x-pack/plugins/spaces/public/copy_saved_objects_to_space/components/copy_to_space_flyout_internal.tsx" + }, + { + "plugin": "savedObjectsManagement", + "path": "src/plugins/saved_objects_management/public/lib/resolve_import_errors.ts" + } + ] }, - "" - ], - "path": "src/core/public/plugins/plugin.ts", - "deprecated": false, - "returnComment": [], - "children": [ { "parentPluginId": "core", - "id": "def-public.PluginInitializer.$1", + "id": "def-public.SavedObjectsImportSuccess.meta", "type": "Object", "tags": [], - "label": "core", + "label": "meta", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.PluginInitializerContext", - "text": "PluginInitializerContext" - }, - "" + "{ title?: string | undefined; icon?: string | undefined; }" ], - "path": "src/core/public/plugins/plugin.ts", + "path": "src/core/server/saved_objects/import/types.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.PluginOpaqueId", - "type": "Type", - "tags": [], - "label": "PluginOpaqueId", - "description": [], - "signature": [ - "symbol" + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportSuccess.overwrite", + "type": "CompoundType", + "tags": [], + "label": "overwrite", + "description": [ + "\nIf `overwrite` is specified, this object overwrote an existing one (or will do so, in the case of a pending resolution)." + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + } ], - "path": "node_modules/@types/kbn__core-base-common/index.d.ts", - "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.PublicUiSettingsParams", - "type": "Type", + "id": "def-public.SavedObjectsImportUnknownError", + "type": "Interface", "tags": [], - "label": "PublicUiSettingsParams", + "label": "SavedObjectsImportUnknownError", "description": [ - "\nA sub-set of {@link UiSettingsParams} exposed to the client-side." - ], - "signature": [ - "{ metric?: { type: string; name: string; } | undefined; type?: ", - "UiSettingsType", - " | undefined; value?: unknown; description?: string | undefined; name?: string | undefined; options?: string[] | undefined; order?: number | undefined; category?: string[] | undefined; optionLabels?: Record | undefined; requiresPageReload?: boolean | undefined; readonly?: boolean | undefined; sensitive?: boolean | undefined; deprecation?: ", - "DeprecationSettings", - " | undefined; }" + "\nRepresents a failure to import due to an unknown reason." ], - "path": "src/core/types/ui_settings.ts", + "path": "src/core/server/saved_objects/import/types.ts", "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.ResolveDeprecationResponse", - "type": "Type", - "tags": [], - "label": "ResolveDeprecationResponse", - "description": [], - "signature": [ - "{ status: \"ok\"; } | { status: \"fail\"; reason: string; }" + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportUnknownError.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"unknown\"" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportUnknownError.message", + "type": "string", + "tags": [], + "label": "message", + "description": [], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportUnknownError.statusCode", + "type": "number", + "tags": [], + "label": "statusCode", + "description": [], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + } ], - "path": "src/core/public/deprecations/deprecations_client.ts", - "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectAttribute", - "type": "Type", + "id": "def-public.SavedObjectsImportUnsupportedTypeError", + "type": "Interface", "tags": [], - "label": "SavedObjectAttribute", + "label": "SavedObjectsImportUnsupportedTypeError", "description": [ - "\nType definition for a Saved Object attribute value\n" - ], - "signature": [ - "SavedObjectAttributeSingle", - " | ", - "SavedObjectAttributeSingle", - "[]" + "\nRepresents a failure to import due to having an unsupported saved object type." ], - "path": "src/core/types/saved_objects.ts", + "path": "src/core/server/saved_objects/import/types.ts", "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportUnsupportedTypeError.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"unsupported_type\"" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectAttributeSingle", - "type": "Type", + "id": "def-public.SavedObjectsMigrationVersion", + "type": "Interface", "tags": [], - "label": "SavedObjectAttributeSingle", + "label": "SavedObjectsMigrationVersion", "description": [ - "\nDon't use this type, it's simply a helper type for {@link SavedObjectAttribute}\n" - ], - "signature": [ - "string | number | boolean | ", - "SavedObjectAttributes", - " | null | undefined" + "\nInformation about the migrations that have been applied to this SavedObject.\nWhen Kibana starts up, KibanaMigrator detects outdated documents and\nmigrates them based on this value. For each migration that has been applied,\nthe plugin's name is used as a key and the latest migration version as the\nvalue.\n" ], "path": "src/core/types/saved_objects.ts", "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsMigrationVersion.Unnamed", + "type": "IndexSignature", + "tags": [], + "label": "[pluginName: string]: string", + "description": [], + "signature": [ + "[pluginName: string]: string" + ], + "path": "src/core/types/saved_objects.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportWarning", - "type": "Type", + "id": "def-public.SavedObjectsResolveResponse", + "type": "Interface", "tags": [], - "label": "SavedObjectsImportWarning", + "label": "SavedObjectsResolveResponse", "description": [ - "\nComposite type of all the possible types of import warnings.\n\nSee {@link SavedObjectsImportSimpleWarning} and {@link SavedObjectsImportActionRequiredWarning}\nfor more details.\n" + "\n" ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportSimpleWarning", - "text": "SavedObjectsImportSimpleWarning" + "section": "def-server.SavedObjectsResolveResponse", + "text": "SavedObjectsResolveResponse" }, - " | ", + "" + ], + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportActionRequiredWarning", - "text": "SavedObjectsImportActionRequiredWarning" + "parentPluginId": "core", + "id": "def-public.SavedObjectsResolveResponse.saved_object", + "type": "Object", + "tags": [], + "label": "saved_object", + "description": [ + "\nThe saved object that was found." + ], + "signature": [ + "SavedObject", + "" + ], + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsResolveResponse.outcome", + "type": "CompoundType", + "tags": [], + "label": "outcome", + "description": [ + "\nThe outcome for a successful `resolve` call is one of the following values:\n\n * `'exactMatch'` -- One document exactly matched the given ID.\n * `'aliasMatch'` -- One document with a legacy URL alias matched the given ID; in this case the `saved_object.id` field is different\n than the given ID.\n * `'conflict'` -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the\n `saved_object` object is the exact match, and the `saved_object.id` field is the same as the given ID." + ], + "signature": [ + "\"exactMatch\" | \"aliasMatch\" | \"conflict\"" + ], + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsResolveResponse.alias_target_id", + "type": "string", + "tags": [], + "label": "alias_target_id", + "description": [ + "\nThe ID of the object that the legacy URL alias points to.\n\n**Note:** this field is *only* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`)." + ], + "signature": [ + "string | undefined" + ], + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsResolveResponse.alias_purpose", + "type": "CompoundType", + "tags": [], + "label": "alias_purpose", + "description": [ + "\nThe reason this alias was created.\n\nCurrently this is used to determine whether or not a toast should be shown when a user is redirected from a legacy URL; if the alias\nwas created because of saved object conversion, then we will display a toast telling the user that the object has a new URL.\n\n**Note:** this field is *only* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`)." + ], + "signature": [ + "\"savedObjectConversion\" | \"savedObjectImport\" | undefined" + ], + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "deprecated": false } ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsNamespaceType", - "type": "Type", + "id": "def-public.ShipperClassConstructor", + "type": "Interface", "tags": [], - "label": "SavedObjectsNamespaceType", + "label": "ShipperClassConstructor", "description": [ - "\nThe namespace type dictates how a saved object can be interacted in relation to namespaces. Each type is mutually exclusive:\n * single (default): This type of saved object is namespace-isolated, e.g., it exists in only one namespace.\n * multiple: This type of saved object is shareable, e.g., it can exist in one or more namespaces.\n * multiple-isolated: This type of saved object is namespace-isolated, e.g., it exists in only one namespace, but object IDs must be\n unique across all namespaces. This is intended to be an intermediate step when objects with a \"single\" namespace type are being\n converted to a \"multiple\" namespace type. In other words, objects with a \"multiple-isolated\" namespace type will be *share-capable*,\n but will not actually be shareable until the namespace type is changed to \"multiple\".\n * agnostic: This type of saved object is global.\n" + "\nConstructor of a {@link IShipper}" ], "signature": [ - "\"multiple\" | \"single\" | \"multiple-isolated\" | \"agnostic\"" + "ShipperClassConstructor", + "" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.StartServicesAccessor", - "type": "Type", - "tags": [], - "label": "StartServicesAccessor", - "description": [ - "\nAllows plugins to get access to APIs available in start inside async\nhandlers, such as {@link App.mount}. Promise will not resolve until Core\nand plugin dependencies have completed `start`.\n" - ], - "signature": [ - "() => Promise<[", + "children": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.CoreStart", - "text": "CoreStart" + "parentPluginId": "core", + "id": "def-public.ShipperClassConstructor.shipperName", + "type": "string", + "tags": [], + "label": "shipperName", + "description": [ + "\nThe shipper's unique name" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false }, - ", TPluginsStart, TStart]>" + { + "parentPluginId": "core", + "id": "def-public.ShipperClassConstructor.new", + "type": "Function", + "tags": [], + "label": "new", + "description": [ + "\nThe constructor" + ], + "signature": [ + "any" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.ShipperClassConstructor.new.$1", + "type": "Uncategorized", + "tags": [], + "label": "config", + "description": [ + "The shipper's custom config" + ], + "signature": [ + "Config" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.ShipperClassConstructor.new.$2", + "type": "Object", + "tags": [], + "label": "initContext", + "description": [ + "Common context {@link AnalyticsClientInitContext }" + ], + "signature": [ + "AnalyticsClientInitContext" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } ], - "path": "src/core/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.TelemetryCounterType", - "type": "Type", + "id": "def-public.TelemetryCounter", + "type": "Interface", "tags": [], - "label": "TelemetryCounterType", + "label": "TelemetryCounter", "description": [ - "\nIndicates if the event contains data about succeeded, failed or dropped events:\n- enqueued: The event was accepted and will be sent to the shippers when they become available (and opt-in === true).\n- sent_to_shipper: The event was sent to at least one shipper.\n- succeeded: The event was successfully sent by the shipper.\n- failed: There was an error when processing/shipping the event. Refer to the Telemetry Counter's code for the reason.\n- dropped: The event was dropped from the queue. Refer to the Telemetry Counter's code for the reason." - ], - "signature": [ - "\"failed\" | \"enqueued\" | \"sent_to_shipper\" | \"succeeded\" | \"dropped\"" + "\nShape of the events emitted by the telemetryCounter$ observable" ], "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.Toast", - "type": "Type", - "tags": [], - "label": "Toast", - "description": [], - "signature": [ - "Pick<", - "Toast", - ", \"children\" | \"color\" | \"className\" | \"onChange\" | \"onKeyDown\" | \"onClick\" | \"security\" | \"defaultValue\" | \"hidden\" | \"lang\" | \"onError\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"toastLifeTimeMs\" | \"iconType\" | \"onClose\" | \"data-test-subj\"> & { title?: string | ", + "children": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" + "parentPluginId": "core", + "id": "def-public.TelemetryCounter.type", + "type": "CompoundType", + "tags": [], + "label": "type", + "description": [ + "\n{@link TelemetryCounterType}" + ], + "signature": [ + "\"failed\" | \"enqueued\" | \"sent_to_shipper\" | \"succeeded\" | \"dropped\"" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false }, - " | undefined; text?: string | ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" + "parentPluginId": "core", + "id": "def-public.TelemetryCounter.source", + "type": "string", + "tags": [], + "label": "source", + "description": [ + "\nWho emitted the event? It can be \"client\" or the name of the shipper." + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false }, - " | undefined; } & { id: string; }" + { + "parentPluginId": "core", + "id": "def-public.TelemetryCounter.event_type", + "type": "string", + "tags": [], + "label": "event_type", + "description": [ + "\nThe event type the success/failure/drop event refers to." + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.TelemetryCounter.code", + "type": "string", + "tags": [], + "label": "code", + "description": [ + "\nCode to provide additional information about the success or failure. Examples are 200/400/504/ValidationError/UnknownError" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.TelemetryCounter.count", + "type": "number", + "tags": [], + "label": "count", + "description": [ + "\nThe number of events that this counter refers to." + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + } ], - "path": "src/core/public/notifications/toasts/toasts_api.tsx", - "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.ToastInput", - "type": "Type", + "id": "def-public.ThemeServiceSetup", + "type": "Interface", "tags": [], - "label": "ToastInput", - "description": [ - "\nInputs for {@link IToasts} APIs." - ], - "signature": [ - "string | ", + "label": "ThemeServiceSetup", + "description": [], + "path": "node_modules/@types/kbn__core-theme-browser/index.d.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInputFields", - "text": "ToastInputFields" + "parentPluginId": "core", + "id": "def-public.ThemeServiceSetup.theme$", + "type": "Object", + "tags": [], + "label": "theme$", + "description": [], + "signature": [ + "Observable", + "<", + "CoreTheme", + ">" + ], + "path": "node_modules/@types/kbn__core-theme-browser/index.d.ts", + "deprecated": false } ], - "path": "src/core/public/notifications/toasts/toasts_api.tsx", - "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.ToastInputFields", - "type": "Type", + "id": "def-public.ThemeServiceStart", + "type": "Interface", "tags": [], - "label": "ToastInputFields", - "description": [ - "\nAllowed fields for {@link ToastInput}.\n" - ], - "signature": [ - "Pick<", - "Toast", - ", \"children\" | \"color\" | \"className\" | \"onChange\" | \"onKeyDown\" | \"onClick\" | \"security\" | \"defaultValue\" | \"hidden\" | \"lang\" | \"onError\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"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 | ", + "label": "ThemeServiceStart", + "description": [], + "path": "node_modules/@types/kbn__core-theme-browser/index.d.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - " | undefined; }" + "parentPluginId": "core", + "id": "def-public.ThemeServiceStart.theme$", + "type": "Object", + "tags": [], + "label": "theme$", + "description": [], + "signature": [ + "Observable", + "<", + "CoreTheme", + ">" + ], + "path": "node_modules/@types/kbn__core-theme-browser/index.d.ts", + "deprecated": false + } ], - "path": "src/core/public/notifications/toasts/toasts_api.tsx", - "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.ToastsSetup", - "type": "Type", + "id": "def-public.ToastOptions", + "type": "Interface", "tags": [], - "label": "ToastsSetup", + "label": "ToastOptions", "description": [ - "\n{@link IToasts}" + "\nOptions available for {@link IToasts} APIs." ], - "signature": [ - "{ add: (toastOrTitle: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" - }, - ") => ", + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; get$: () => ", - "Observable", - "<", + "parentPluginId": "core", + "id": "def-public.ToastOptions.toastLifeTimeMs", + "type": "number", + "tags": [], + "label": "toastLifeTimeMs", + "description": [ + "\nHow long should the toast remain on screen." + ], + "signature": [ + "number | undefined" + ], + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.UiSettingsParams", + "type": "Interface", + "tags": [], + "label": "UiSettingsParams", + "description": [ + "\nUiSettings parameters defined by the plugins." + ], + "signature": [ + "UiSettingsParams", + "" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.name", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "title in the UI" + ], + "signature": [ + "string | undefined" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false }, - "[]>; remove: (toastOrId: string | ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.value", + "type": "Uncategorized", + "tags": [], + "label": "value", + "description": [ + "default value to fall back to if a user doesn't provide any" + ], + "signature": [ + "T | undefined" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false }, - ") => void; addSuccess: (toastOrTitle: ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.description", + "type": "string", + "tags": [], + "label": "description", + "description": [ + "description provided to a user in UI" + ], + "signature": [ + "string | undefined" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false }, - ", options?: ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastOptions", - "text": "ToastOptions" + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.category", + "type": "Array", + "tags": [], + "label": "category", + "description": [ + "used to group the configured setting in the UI" + ], + "signature": [ + "string[] | undefined" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false }, - " | undefined) => ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.options", + "type": "Array", + "tags": [], + "label": "options", + "description": [ + "array of permitted values for this setting" + ], + "signature": [ + "string[] | undefined" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false }, - "; addWarning: (toastOrTitle: ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.optionLabels", + "type": "Object", + "tags": [], + "label": "optionLabels", + "description": [ + "text labels for 'select' type UI element" + ], + "signature": [ + "Record | undefined" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false }, - ", options?: ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastOptions", - "text": "ToastOptions" + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.requiresPageReload", + "type": "CompoundType", + "tags": [], + "label": "requiresPageReload", + "description": [ + "a flag indicating whether new value applying requires page reloading" + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false }, - " | undefined) => ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.readonly", + "type": "CompoundType", + "tags": [], + "label": "readonly", + "description": [ + "a flag indicating that value cannot be changed" + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false }, - "; addDanger: (toastOrTitle: ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.sensitive", + "type": "CompoundType", + "tags": [], + "label": "sensitive", + "description": [ + "\na flag indicating that value might contain user sensitive data.\nused by telemetry to mask the value of the setting when sent." + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false }, - ", options?: ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastOptions", - "text": "ToastOptions" + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.type", + "type": "CompoundType", + "tags": [], + "label": "type", + "description": [ + "defines a type of UI element {@link UiSettingsType}" + ], + "signature": [ + "UiSettingsType", + " | undefined" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false }, - " | undefined) => ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.deprecation", + "type": "Object", + "tags": [], + "label": "deprecation", + "description": [ + "optional deprecation information. Used to generate a deprecation warning." + ], + "signature": [ + "DeprecationSettings", + " | undefined" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false }, - "; addError: (error: Error, options: ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ErrorToastOptions", - "text": "ErrorToastOptions" + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.order", + "type": "number", + "tags": [], + "label": "order", + "description": [ + "\nindex of the settings within its category (ascending order, smallest will be displayed first).\nUsed for ordering in the UI.\n" + ], + "signature": [ + "number | undefined" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false }, - ") => ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.schema", + "type": "Object", + "tags": [], + "label": "schema", + "description": [], + "signature": [ + "Type", + "" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false }, - "; addInfo: (toastOrTitle: ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" - }, - ", options?: ", + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.metric", + "type": "Object", + "tags": [ + "deprecated" + ], + "label": "metric", + "description": [ + "\nMetric to track once this property changes" + ], + "signature": [ + "{ type: string; name: string; } | undefined" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": true, + "references": [ + { + "plugin": "advancedSettings", + "path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/server/ui_settings.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/server/ui_settings.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/server/ui_settings.ts" + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.UiSettingsState", + "type": "Interface", + "tags": [], + "label": "UiSettingsState", + "description": [], + "path": "src/core/public/ui_settings/types.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastOptions", - "text": "ToastOptions" - }, - " | undefined) => ", + "parentPluginId": "core", + "id": "def-public.UiSettingsState.Unnamed", + "type": "IndexSignature", + "tags": [], + "label": "[key: string]: PublicUiSettingsParams & UserProvidedValues", + "description": [], + "signature": [ + "[key: string]: ", + "PublicUiSettingsParams", + " & ", + "UserProvidedValues", + "" + ], + "path": "src/core/public/ui_settings/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.UserProvidedValues", + "type": "Interface", + "tags": [], + "label": "UserProvidedValues", + "description": [ + "\nDescribes the values explicitly set by user." + ], + "signature": [ + "UserProvidedValues", + "" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" + "parentPluginId": "core", + "id": "def-public.UserProvidedValues.userValue", + "type": "Uncategorized", + "tags": [], + "label": "userValue", + "description": [], + "signature": [ + "T | undefined" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false }, - "; }" + { + "parentPluginId": "core", + "id": "def-public.UserProvidedValues.isOverridden", + "type": "CompoundType", + "tags": [], + "label": "isOverridden", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false + } ], - "path": "src/core/public/notifications/toasts/toasts_service.tsx", + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "core", + "id": "def-public.AnalyticsServiceSetup", + "type": "Type", + "tags": [], + "label": "AnalyticsServiceSetup", + "description": [ + "\nExposes the public APIs of the AnalyticsClient during the setup phase.\n{@link AnalyticsClient}" + ], + "signature": [ + "{ optIn: (optInConfig: ", + "OptInConfig", + ") => void; reportEvent: >(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ", + "Observable", + "<", + "TelemetryCounter", + ">; registerEventType: (eventTypeOps: ", + "EventTypeOpts", + ") => void; registerShipper: (Shipper: ", + "ShipperClassConstructor", + ", shipperConfig: ShipperConfig, opts?: ", + "RegisterShipperOpts", + " | undefined) => void; registerContextProvider: (contextProviderOpts: ", + "ContextProviderOpts", + ") => void; removeContextProvider: (contextProviderName: string) => void; }" + ], + "path": "node_modules/@types/kbn__core-analytics-browser/index.d.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.ToastsStart", + "id": "def-public.AnalyticsServiceStart", "type": "Type", "tags": [], - "label": "ToastsStart", + "label": "AnalyticsServiceStart", "description": [ - "\n{@link IToasts}" + "\nExposes the public APIs of the AnalyticsClient during the start phase\n{@link AnalyticsClient}" ], "signature": [ - "{ add: (toastOrTitle: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" - }, - ") => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; get$: () => ", + "{ optIn: (optInConfig: ", + "OptInConfig", + ") => void; reportEvent: >(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ", "Observable", "<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "[]>; remove: (toastOrId: string | ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" + "TelemetryCounter", + ">; }" + ], + "path": "node_modules/@types/kbn__core-analytics-browser/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.APP_WRAPPER_CLASS", + "type": "string", + "tags": [], + "label": "APP_WRAPPER_CLASS", + "description": [ + "\nThe class name for top level *and* nested application wrappers to ensure proper layout" + ], + "signature": [ + "\"kbnAppWrapper\"" + ], + "path": "src/core/utils/app_wrapper_class.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.EventType", + "type": "Type", + "tags": [], + "label": "EventType", + "description": [ + "\nEvent Type used for indexed structures. Only used to improve the readability of the types" + ], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.ExecutionContextStart", + "type": "Type", + "tags": [], + "label": "ExecutionContextStart", + "description": [ + "\nSee {@link ExecutionContextSetup}." + ], + "signature": [ + "ExecutionContextSetup" + ], + "path": "node_modules/@types/kbn__core-execution-context-browser/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.FatalErrorsStart", + "type": "Type", + "tags": [], + "label": "FatalErrorsStart", + "description": [ + "\nFatalErrors stop the Kibana Public Core and displays a fatal error screen\nwith details about the Kibana build and the error.\n" + ], + "signature": [ + "FatalErrorsSetup" + ], + "path": "node_modules/@types/kbn__core-fatal-errors-browser/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpStart", + "type": "Type", + "tags": [], + "label": "HttpStart", + "description": [ + "\nSee {@link HttpSetup}" + ], + "signature": [ + "HttpSetup" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.IToasts", + "type": "Type", + "tags": [], + "label": "IToasts", + "description": [ + "\nMethods for adding and removing global toast messages. See {@link ToastsApi}." + ], + "signature": [ + "{ add: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; get$: () => ", + "Observable", + "<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "[]>; remove: (toastOrId: string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" }, ") => void; addSuccess: (toastOrTitle: ", { @@ -8441,1363 +9402,1145 @@ }, "; }" ], - "path": "src/core/public/notifications/toasts/toasts_service.tsx", + "path": "src/core/public/notifications/toasts/toasts_api.tsx", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsType", + "id": "def-public.KibanaExecutionContext", "type": "Type", "tags": [], - "label": "UiSettingsType", - "description": [ - "\nUI element type to represent the settings." - ], + "label": "KibanaExecutionContext", + "description": [], "signature": [ - "\"string\" | \"number\" | \"boolean\" | \"undefined\" | \"color\" | \"image\" | \"json\" | \"markdown\" | \"select\" | \"array\"" + "{ readonly type?: string | undefined; readonly name?: string | undefined; readonly page?: string | undefined; readonly id?: string | undefined; readonly description?: string | undefined; readonly url?: string | undefined; child?: ", + "KibanaExecutionContext", + " | undefined; }" ], - "path": "src/core/types/ui_settings.ts", + "path": "node_modules/@types/kbn__core-execution-context-common/index.d.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.UnmountCallback", + "id": "def-public.MountPoint", "type": "Type", "tags": [], - "label": "UnmountCallback", + "label": "MountPoint", "description": [ - "\nA function that will unmount the element previously mounted by\nthe associated {@link MountPoint}\n" + "\nA function that should mount DOM content inside the provided container element\nand return a handler to unmount it.\n" ], "signature": [ - "() => void" + "(element: T) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.UnmountCallback", + "text": "UnmountCallback" + } ], "path": "src/core/public/types.ts", "deprecated": false, - "returnComment": [], - "children": [], + "returnComment": [ + "a {@link UnmountCallback } that unmount the element on call." + ], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.MountPoint.$1", + "type": "Uncategorized", + "tags": [], + "label": "element", + "description": [ + "the container element to render into" + ], + "signature": [ + "T" + ], + "path": "src/core/public/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.URL_MAX_LENGTH", - "type": "CompoundType", + "id": "def-public.PluginInitializer", + "type": "Type", "tags": [], - "label": "URL_MAX_LENGTH", + "label": "PluginInitializer", "description": [ - "\nThe max URL length allowed by the current browser. Should be used to display warnings to users when query parameters\ncause URL to exceed this limit." + "\nThe `plugin` export at the root of a plugin's `public` directory should conform\nto this interface.\n" ], "signature": [ - "2000 | 25000" - ], - "path": "src/core/public/core_app/errors/url_overflow.tsx", - "deprecated": false, - "initialIsOpen": false - } - ], - "objects": [] - }, - "server": { - "classes": [ - { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig", - "type": "Class", - "tags": [], - "label": "ElasticsearchConfig", - "description": [ - "\nWrapper of config schema." + "(core: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.PluginInitializerContext", + "text": "PluginInitializerContext" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Plugin", + "text": "Plugin" + }, + "" ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "path": "src/core/public/plugins/plugin.ts", "deprecated": false, + "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.healthCheckDelay", + "id": "def-public.PluginInitializer.$1", "type": "Object", "tags": [], - "label": "healthCheckDelay", - "description": [ - "\nThe interval between health check requests Kibana sends to the Elasticsearch." - ], + "label": "core", + "description": [], "signature": [ - "moment.Duration" - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.ignoreVersionMismatch", - "type": "boolean", - "tags": [], - "label": "ignoreVersionMismatch", - "description": [ - "\nWhether to allow kibana to connect to a non-compatible elasticsearch node." + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.PluginInitializerContext", + "text": "PluginInitializerContext" + }, + "" ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "path": "src/core/public/plugins/plugin.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.PluginOpaqueId", + "type": "Type", + "tags": [], + "label": "PluginOpaqueId", + "description": [], + "signature": [ + "symbol" + ], + "path": "node_modules/@types/kbn__core-base-common/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.PublicUiSettingsParams", + "type": "Type", + "tags": [], + "label": "PublicUiSettingsParams", + "description": [ + "\nA sub-set of {@link UiSettingsParams} exposed to the client-side." + ], + "signature": [ + "{ metric?: { type: string; name: string; } | undefined; type?: ", + "UiSettingsType", + " | undefined; value?: unknown; description?: string | undefined; name?: string | undefined; options?: string[] | undefined; order?: number | undefined; category?: string[] | undefined; optionLabels?: Record | undefined; requiresPageReload?: boolean | undefined; readonly?: boolean | undefined; sensitive?: boolean | undefined; deprecation?: ", + "DeprecationSettings", + " | undefined; }" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.ResolveDeprecationResponse", + "type": "Type", + "tags": [], + "label": "ResolveDeprecationResponse", + "description": [], + "signature": [ + "{ status: \"ok\"; } | { status: \"fail\"; reason: string; }" + ], + "path": "src/core/public/deprecations/deprecations_client.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectAttribute", + "type": "Type", + "tags": [], + "label": "SavedObjectAttribute", + "description": [ + "\nType definition for a Saved Object attribute value\n" + ], + "signature": [ + "SavedObjectAttributeSingle", + " | ", + "SavedObjectAttributeSingle", + "[]" + ], + "path": "src/core/types/saved_objects.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectAttributeSingle", + "type": "Type", + "tags": [], + "label": "SavedObjectAttributeSingle", + "description": [ + "\nDon't use this type, it's simply a helper type for {@link SavedObjectAttribute}\n" + ], + "signature": [ + "string | number | boolean | ", + "SavedObjectAttributes", + " | null | undefined" + ], + "path": "src/core/types/saved_objects.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportWarning", + "type": "Type", + "tags": [], + "label": "SavedObjectsImportWarning", + "description": [ + "\nComposite type of all the possible types of import warnings.\n\nSee {@link SavedObjectsImportSimpleWarning} and {@link SavedObjectsImportActionRequiredWarning}\nfor more details.\n" + ], + "signature": [ { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.apiVersion", - "type": "string", - "tags": [], - "label": "apiVersion", - "description": [ - "\nVersion of the Elasticsearch (6.7, 7.1 or `master`) client will be connecting to." - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportSimpleWarning", + "text": "SavedObjectsImportSimpleWarning" }, + " | ", { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.maxSockets", - "type": "number", - "tags": [], - "label": "maxSockets", - "description": [ - "\nThe maximum number of sockets that can be used for communications with elasticsearch." - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false - }, + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportActionRequiredWarning", + "text": "SavedObjectsImportActionRequiredWarning" + } + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsNamespaceType", + "type": "Type", + "tags": [], + "label": "SavedObjectsNamespaceType", + "description": [ + "\nThe namespace type dictates how a saved object can be interacted in relation to namespaces. Each type is mutually exclusive:\n * single (default): This type of saved object is namespace-isolated, e.g., it exists in only one namespace.\n * multiple: This type of saved object is shareable, e.g., it can exist in one or more namespaces.\n * multiple-isolated: This type of saved object is namespace-isolated, e.g., it exists in only one namespace, but object IDs must be\n unique across all namespaces. This is intended to be an intermediate step when objects with a \"single\" namespace type are being\n converted to a \"multiple\" namespace type. In other words, objects with a \"multiple-isolated\" namespace type will be *share-capable*,\n but will not actually be shareable until the namespace type is changed to \"multiple\".\n * agnostic: This type of saved object is global.\n" + ], + "signature": [ + "\"multiple\" | \"single\" | \"multiple-isolated\" | \"agnostic\"" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.StartServicesAccessor", + "type": "Type", + "tags": [], + "label": "StartServicesAccessor", + "description": [ + "\nAllows plugins to get access to APIs available in start inside async\nhandlers, such as {@link App.mount}. Promise will not resolve until Core\nand plugin dependencies have completed `start`.\n" + ], + "signature": [ + "() => Promise<[", { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.compression", - "type": "boolean", - "tags": [], - "label": "compression", - "description": [ - "\nWhether to use compression for communications with elasticsearch." - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" }, + ", TPluginsStart, TStart]>" + ], + "path": "src/core/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.TelemetryCounterType", + "type": "Type", + "tags": [], + "label": "TelemetryCounterType", + "description": [ + "\nIndicates if the event contains data about succeeded, failed or dropped events:\n- enqueued: The event was accepted and will be sent to the shippers when they become available (and opt-in === true).\n- sent_to_shipper: The event was sent to at least one shipper.\n- succeeded: The event was successfully sent by the shipper.\n- failed: There was an error when processing/shipping the event. Refer to the Telemetry Counter's code for the reason.\n- dropped: The event was dropped from the queue. Refer to the Telemetry Counter's code for the reason." + ], + "signature": [ + "\"failed\" | \"enqueued\" | \"sent_to_shipper\" | \"succeeded\" | \"dropped\"" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.Toast", + "type": "Type", + "tags": [], + "label": "Toast", + "description": [], + "signature": [ + "Pick<", + "Toast", + ", \"children\" | \"color\" | \"className\" | \"onChange\" | \"onKeyDown\" | \"onClick\" | \"security\" | \"defaultValue\" | \"hidden\" | \"lang\" | \"onError\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"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 | ", { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.hosts", - "type": "Array", - "tags": [], - "label": "hosts", - "description": [ - "\nHosts that the client will connect to. If sniffing is enabled, this list will\nbe used as seeds to discover the rest of your cluster." - ], - "signature": [ - "string[]" - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" }, + " | undefined; text?: string | ", { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.requestHeadersWhitelist", - "type": "Array", - "tags": [], - "label": "requestHeadersWhitelist", - "description": [ - "\nList of Kibana client-side headers to send to Elasticsearch when request\nscoped cluster client is used. If this is an empty array then *no* client-side\nwill be sent." - ], - "signature": [ - "string[]" - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.pingTimeout", - "type": "Object", - "tags": [], - "label": "pingTimeout", - "description": [ - "\nTimeout after which PING HTTP request will be aborted and retried." - ], - "signature": [ - "moment.Duration" - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" }, + " | undefined; } & { id: string; }" + ], + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.ToastInput", + "type": "Type", + "tags": [], + "label": "ToastInput", + "description": [ + "\nInputs for {@link IToasts} APIs." + ], + "signature": [ + "string | ", { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.requestTimeout", - "type": "Object", - "tags": [], - "label": "requestTimeout", - "description": [ - "\nTimeout after which HTTP request will be aborted and retried." - ], - "signature": [ - "moment.Duration" - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInputFields", + "text": "ToastInputFields" + } + ], + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.ToastInputFields", + "type": "Type", + "tags": [], + "label": "ToastInputFields", + "description": [ + "\nAllowed fields for {@link ToastInput}.\n" + ], + "signature": [ + "Pick<", + "Toast", + ", \"children\" | \"color\" | \"className\" | \"onChange\" | \"onKeyDown\" | \"onClick\" | \"security\" | \"defaultValue\" | \"hidden\" | \"lang\" | \"onError\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"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 | ", { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.shardTimeout", - "type": "Object", - "tags": [], - "label": "shardTimeout", - "description": [ - "\nTimeout for Elasticsearch to wait for responses from shards. Set to 0 to disable." - ], - "signature": [ - "moment.Duration" - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" }, + " | undefined; }" + ], + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.ToastsSetup", + "type": "Type", + "tags": [], + "label": "ToastsSetup", + "description": [ + "\n{@link IToasts}" + ], + "signature": [ + "{ add: (toastOrTitle: ", { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.sniffOnStart", - "type": "boolean", - "tags": [], - "label": "sniffOnStart", - "description": [ - "\nSpecifies whether the client should attempt to detect the rest of the cluster\nwhen it is first instantiated." - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" }, + ") => ", { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.sniffInterval", - "type": "CompoundType", - "tags": [], - "label": "sniffInterval", - "description": [ - "\nInterval to perform a sniff operation and make sure the list of nodes is complete.\nIf `false` then sniffing is disabled." - ], - "signature": [ - "false | moment.Duration" - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" }, + "; get$: () => ", + "Observable", + "<", { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.sniffOnConnectionFault", - "type": "boolean", - "tags": [], - "label": "sniffOnConnectionFault", - "description": [ - "\nSpecifies whether the client should immediately sniff for a more current list\nof nodes when a connection dies." - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" }, + "[]>; remove: (toastOrId: string | ", { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.username", - "type": "string", - "tags": [], - "label": "username", - "description": [ - "\nIf Elasticsearch is protected with basic authentication, this setting provides\nthe username that the Kibana server uses to perform its administrative functions.\nCannot be used in conjunction with serviceAccountToken." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" }, + ") => void; addSuccess: (toastOrTitle: ", { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.password", - "type": "string", - "tags": [], - "label": "password", - "description": [ - "\nIf Elasticsearch is protected with basic authentication, this setting provides\nthe password that the Kibana server uses to perform its administrative functions." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" }, + ", options?: ", { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.serviceAccountToken", - "type": "string", - "tags": [], - "label": "serviceAccountToken", - "description": [ - "\nIf Elasticsearch security features are enabled, this setting provides the service account\ntoken that the Kibana server users to perform its administrative functions.\n\nThis is an alternative to specifying a username and password." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" }, + " | undefined) => ", { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.ssl", - "type": "CompoundType", - "tags": [], - "label": "ssl", - "description": [ - "\nSet of settings configure SSL connection between Kibana and Elasticsearch that\nare required when `xpack.ssl.verification_mode` in Elasticsearch is set to\neither `certificate` or `full`." - ], - "signature": [ - "Pick; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>, \"key\" | \"verificationMode\" | \"certificate\" | \"keyPassphrase\" | \"alwaysPresentCertificate\"> & { certificateAuthorities?: string[] | undefined; }" - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" }, + "; addWarning: (toastOrTitle: ", { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.customHeaders", - "type": "Object", - "tags": [], - "label": "customHeaders", - "description": [ - "\nHeader names and values to send to Elasticsearch with every request. These\nheaders cannot be overwritten by client-side headers and aren't affected by\n`requestHeadersWhitelist` configuration." - ], - "signature": [ - "{ [x: string]: string; }" - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" }, + ", options?: ", { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.Unnamed.$1", - "type": "Object", - "tags": [], - "label": "rawConfig", - "description": [], - "signature": [ - "Readonly<{ username?: string | undefined; password?: string | undefined; serviceAccountToken?: string | undefined; } & { ssl: Readonly<{ key?: string | undefined; certificateAuthorities?: string | string[] | undefined; certificate?: string | undefined; keyPassphrase?: string | undefined; } & { verificationMode: \"none\" | \"full\" | \"certificate\"; keystore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>; healthCheck: Readonly<{} & { delay: moment.Duration; }>; customHeaders: Record; hosts: string | string[]; sniffOnStart: boolean; sniffInterval: false | moment.Duration; sniffOnConnectionFault: boolean; maxSockets: number; compression: boolean; requestHeadersWhitelist: string | string[]; shardTimeout: moment.Duration; requestTimeout: moment.Duration; pingTimeout: moment.Duration; logQueries: boolean; apiVersion: string; ignoreVersionMismatch: boolean; skipStartupConnectionCheck: boolean; }>" - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.EventLoopDelaysMonitor", - "type": "Class", - "tags": [], - "label": "EventLoopDelaysMonitor", - "description": [], - "path": "src/core/server/metrics/event_loop_delays/event_loop_delays_monitor.ts", - "deprecated": false, - "children": [ + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", { - "parentPluginId": "core", - "id": "def-server.EventLoopDelaysMonitor.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [ - "\nCreating a new instance from EventLoopDelaysMonitor will\nautomatically start tracking event loop delays." - ], - "signature": [ - "any" - ], - "path": "src/core/server/metrics/event_loop_delays/event_loop_delays_monitor.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" }, + "; addDanger: (toastOrTitle: ", { - "parentPluginId": "core", - "id": "def-server.EventLoopDelaysMonitor.collect", - "type": "Function", - "tags": [], - "label": "collect", - "description": [ - "\nCollect gathers event loop delays metrics from nodejs perf_hooks.monitorEventLoopDelay\nthe histogram calculations start from the last time `reset` was called or this\nEventLoopDelaysMonitor instance was created.\n\nReturns metrics in milliseconds." - ], - "signature": [ - "() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IntervalHistogram", - "text": "IntervalHistogram" - } - ], - "path": "src/core/server/metrics/event_loop_delays/event_loop_delays_monitor.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" }, + ", options?: ", { - "parentPluginId": "core", - "id": "def-server.EventLoopDelaysMonitor.reset", - "type": "Function", - "tags": [], - "label": "reset", - "description": [ - "\nResets the collected histogram data." - ], - "signature": [ - "() => void" - ], - "path": "src/core/server/metrics/event_loop_delays/event_loop_delays_monitor.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" }, + " | undefined) => ", { - "parentPluginId": "core", - "id": "def-server.EventLoopDelaysMonitor.stop", - "type": "Function", - "tags": [], - "label": "stop", - "description": [ - "\nDisables updating the interval timer for collecting new data points." - ], - "signature": [ - "() => void" - ], - "path": "src/core/server/metrics/event_loop_delays/event_loop_delays_monitor.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - } - ], - "functions": [ - { - "parentPluginId": "core", - "id": "def-server.pollEsNodesVersion", - "type": "Function", - "tags": [], - "label": "pollEsNodesVersion", - "description": [], - "signature": [ - "({ internalClient, log, kibanaVersion, ignoreVersionMismatch, esVersionCheckInterval: healthCheckInterval, }: ", + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addError: (error: Error, options: ", { "pluginId": "core", - "scope": "server", + "scope": "public", "docId": "kibCorePluginApi", - "section": "def-server.PollEsNodesVersionOptions", - "text": "PollEsNodesVersionOptions" + "section": "def-public.ErrorToastOptions", + "text": "ErrorToastOptions" }, ") => ", - "Observable", - "<", { "pluginId": "core", - "scope": "server", + "scope": "public", "docId": "kibCorePluginApi", - "section": "def-server.NodesVersionCompatibility", - "text": "NodesVersionCompatibility" + "section": "def-public.Toast", + "text": "Toast" }, - ">" - ], - "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", - "deprecated": false, - "children": [ + "; addInfo: (toastOrTitle: ", { - "parentPluginId": "core", - "id": "def-server.pollEsNodesVersion.$1", - "type": "Object", - "tags": [], - "label": "{\n internalClient,\n log,\n kibanaVersion,\n ignoreVersionMismatch,\n esVersionCheckInterval: healthCheckInterval,\n}", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.PollEsNodesVersionOptions", - "text": "PollEsNodesVersionOptions" - } - ], - "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", - "deprecated": false, - "isRequired": true - } + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; }" ], - "returnComment": [], + "path": "src/core/public/notifications/toasts/toasts_service.tsx", + "deprecated": false, "initialIsOpen": false - } - ], - "interfaces": [ + }, { "parentPluginId": "core", - "id": "def-server.AnalyticsClient", - "type": "Interface", + "id": "def-public.ToastsStart", + "type": "Type", "tags": [], - "label": "AnalyticsClient", + "label": "ToastsStart", "description": [ - "\nAnalytics client's public APIs" + "\n{@link IToasts}" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "children": [ + "signature": [ + "{ add: (toastOrTitle: ", { - "parentPluginId": "core", - "id": "def-server.AnalyticsClient.reportEvent", - "type": "Function", - "tags": [], - "label": "reportEvent", - "description": [ - "\nReports a telemetry event." - ], - "signature": [ - ">(eventType: string, eventData: EventTypeData) => void" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.AnalyticsClient.reportEvent.$1", - "type": "string", - "tags": [], - "label": "eventType", - "description": [ - "The event type registered via the `registerEventType` API." - ], - "signature": [ - "string" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.AnalyticsClient.reportEvent.$2", - "type": "Uncategorized", - "tags": [], - "label": "eventData", - "description": [ - "The properties matching the schema declared in the `registerEventType` API." - ], - "signature": [ - "EventTypeData" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" }, + ") => ", { - "parentPluginId": "core", - "id": "def-server.AnalyticsClient.registerEventType", - "type": "Function", - "tags": [], - "label": "registerEventType", - "description": [ - "\nRegisters the event type that will be emitted via the reportEvent API." - ], - "signature": [ - "(eventTypeOps: ", - "EventTypeOpts", - ") => void" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.AnalyticsClient.registerEventType.$1", - "type": "Object", - "tags": [], - "label": "eventTypeOps", - "description": [ - "The definition of the event type {@link EventTypeOpts }." - ], - "signature": [ - "EventTypeOpts", - "" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" }, + "; get$: () => ", + "Observable", + "<", { - "parentPluginId": "core", - "id": "def-server.AnalyticsClient.registerShipper", - "type": "Function", - "tags": [], - "label": "registerShipper", - "description": [ - "\nSet up the shipper that will be used to report the telemetry events." - ], - "signature": [ - "(Shipper: ", - "ShipperClassConstructor", - ", shipperConfig: ShipperConfig, opts?: ", - "RegisterShipperOpts", - " | undefined) => void" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.AnalyticsClient.registerShipper.$1", - "type": "Object", - "tags": [], - "label": "Shipper", - "description": [ - "The {@link IShipper } class to instantiate the shipper." - ], - "signature": [ - "ShipperClassConstructor", - "" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.AnalyticsClient.registerShipper.$2", - "type": "Uncategorized", - "tags": [], - "label": "shipperConfig", - "description": [ - "The config specific to the Shipper to instantiate." - ], - "signature": [ - "ShipperConfig" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.AnalyticsClient.registerShipper.$3", - "type": "Object", - "tags": [], - "label": "opts", - "description": [ - "Additional options to register the shipper {@link RegisterShipperOpts }." - ], - "signature": [ - "RegisterShipperOpts", - " | undefined" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" }, + "[]>; remove: (toastOrId: string | ", { - "parentPluginId": "core", - "id": "def-server.AnalyticsClient.optIn", - "type": "Function", - "tags": [], - "label": "optIn", - "description": [ - "\nUsed to control the user's consent to report the data.\nIn the advanced mode, it allows to \"cherry-pick\" which events and shippers are enabled/disabled." - ], - "signature": [ - "(optInConfig: ", - "OptInConfig", - ") => void" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.AnalyticsClient.optIn.$1", - "type": "Object", - "tags": [], - "label": "optInConfig", - "description": [ - "{@link OptInConfig }" - ], - "signature": [ - "OptInConfig" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" }, + ") => void; addSuccess: (toastOrTitle: ", { - "parentPluginId": "core", - "id": "def-server.AnalyticsClient.registerContextProvider", - "type": "Function", - "tags": [], - "label": "registerContextProvider", - "description": [ - "\nRegisters the context provider to enrich the any reported events." - ], - "signature": [ - "(contextProviderOpts: ", - "ContextProviderOpts", - ") => void" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.AnalyticsClient.registerContextProvider.$1", - "type": "Object", - "tags": [], - "label": "contextProviderOpts", - "description": [ - "{@link ContextProviderOpts }" - ], - "signature": [ - "ContextProviderOpts", - "" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" }, + ", options?: ", { - "parentPluginId": "core", - "id": "def-server.AnalyticsClient.removeContextProvider", - "type": "Function", - "tags": [], - "label": "removeContextProvider", - "description": [ - "\nRemoves the context provider and stop enriching the events from its context." - ], - "signature": [ - "(contextProviderName: string) => void" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.AnalyticsClient.removeContextProvider.$1", - "type": "string", - "tags": [], - "label": "contextProviderName", - "description": [ - "The name of the context provider to remove." - ], - "signature": [ - "string" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" }, + " | undefined) => ", { - "parentPluginId": "core", - "id": "def-server.AnalyticsClient.telemetryCounter$", - "type": "Object", - "tags": [], - "label": "telemetryCounter$", - "description": [ - "\nObservable to emit the stats of the processed events." - ], - "signature": [ - "Observable", - "<", - "TelemetryCounter", - ">" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" }, + "; addWarning: (toastOrTitle: ", { - "parentPluginId": "core", - "id": "def-server.AnalyticsClient.shutdown", - "type": "Function", - "tags": [], - "label": "shutdown", - "description": [ - "\nStops the client." - ], - "signature": [ - "() => void" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addDanger: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addError: (error: Error, options: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ErrorToastOptions", + "text": "ErrorToastOptions" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addInfo: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; }" ], + "path": "src/core/public/notifications/toasts/toasts_service.tsx", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.AppCategory", - "type": "Interface", + "id": "def-public.UiSettingsType", + "type": "Type", "tags": [], - "label": "AppCategory", + "label": "UiSettingsType", "description": [ - "\n\nA category definition for nav links to know where to sort them in the left hand nav" + "\nUI element type to represent the settings." ], - "path": "src/core/types/app_category.ts", + "signature": [ + "\"string\" | \"number\" | \"boolean\" | \"undefined\" | \"color\" | \"image\" | \"json\" | \"markdown\" | \"select\" | \"array\"" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.UnmountCallback", + "type": "Type", + "tags": [], + "label": "UnmountCallback", + "description": [ + "\nA function that will unmount the element previously mounted by\nthe associated {@link MountPoint}\n" + ], + "signature": [ + "() => void" + ], + "path": "src/core/public/types.ts", + "deprecated": false, + "returnComment": [], + "children": [], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.URL_MAX_LENGTH", + "type": "CompoundType", + "tags": [], + "label": "URL_MAX_LENGTH", + "description": [ + "\nThe max URL length allowed by the current browser. Should be used to display warnings to users when query parameters\ncause URL to exceed this limit." + ], + "signature": [ + "2000 | 25000" + ], + "path": "src/core/public/core_app/errors/url_overflow.tsx", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [] + }, + "server": { + "classes": [ + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchConfig", + "type": "Class", + "tags": [], + "label": "ElasticsearchConfig", + "description": [ + "\nWrapper of config schema." + ], + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.AppCategory.id", - "type": "string", + "id": "def-server.ElasticsearchConfig.healthCheckDelay", + "type": "Object", "tags": [], - "label": "id", + "label": "healthCheckDelay", "description": [ - "\nUnique identifier for the categories" + "\nThe interval between health check requests Kibana sends to the Elasticsearch." ], - "path": "src/core/types/app_category.ts", + "signature": [ + "moment.Duration" + ], + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.AppCategory.label", - "type": "string", + "id": "def-server.ElasticsearchConfig.ignoreVersionMismatch", + "type": "boolean", "tags": [], - "label": "label", + "label": "ignoreVersionMismatch", "description": [ - "\nLabel used for category name.\nAlso used as aria-label if one isn't set." + "\nWhether to allow kibana to connect to a non-compatible elasticsearch node." ], - "path": "src/core/types/app_category.ts", + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.AppCategory.ariaLabel", + "id": "def-server.ElasticsearchConfig.apiVersion", "type": "string", "tags": [], - "label": "ariaLabel", + "label": "apiVersion", "description": [ - "\nIf the visual label isn't appropriate for screen readers,\ncan override it here" - ], - "signature": [ - "string | undefined" + "\nVersion of the Elasticsearch (6.7, 7.1 or `master`) client will be connecting to." ], - "path": "src/core/types/app_category.ts", + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.AppCategory.order", + "id": "def-server.ElasticsearchConfig.maxSockets", "type": "number", "tags": [], - "label": "order", + "label": "maxSockets", "description": [ - "\nThe order that categories will be sorted in\nPrefer large steps between categories to allow for further editing\n(Default categories are in steps of 1000)" - ], - "signature": [ - "number | undefined" + "\nThe maximum number of sockets that can be used for communications with elasticsearch." ], - "path": "src/core/types/app_category.ts", + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.AppCategory.euiIconType", - "type": "string", + "id": "def-server.ElasticsearchConfig.compression", + "type": "boolean", "tags": [], - "label": "euiIconType", + "label": "compression", "description": [ - "\nDefine an icon to be used for the category\nIf the category is only 1 item, and no icon is defined, will default to the product icon\nDefaults to initials if no icon is defined" - ], - "signature": [ - "string | undefined" + "\nWhether to use compression for communications with elasticsearch." ], - "path": "src/core/types/app_category.ts", + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.AsyncPlugin", - "type": "Interface", - "tags": [ - "deprecated" - ], - "label": "AsyncPlugin", - "description": [ - "\nA plugin with asynchronous lifecycle methods.\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.AsyncPlugin", - "text": "AsyncPlugin" }, - "" - ], - "path": "src/core/server/plugins/types.ts", - "deprecated": true, - "removeBy": "8.8.0", - "references": [], - "children": [ { "parentPluginId": "core", - "id": "def-server.AsyncPlugin.setup", - "type": "Function", + "id": "def-server.ElasticsearchConfig.hosts", + "type": "Array", "tags": [], - "label": "setup", - "description": [], - "signature": [ - "(core: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreSetup", - "text": "CoreSetup" - }, - ", plugins: TPluginsSetup) => TSetup | Promise" + "label": "hosts", + "description": [ + "\nHosts that the client will connect to. If sniffing is enabled, this list will\nbe used as seeds to discover the rest of your cluster." ], - "path": "src/core/server/plugins/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.AsyncPlugin.setup.$1", - "type": "Object", - "tags": [], - "label": "core", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreSetup", - "text": "CoreSetup" - }, - "" - ], - "path": "src/core/server/plugins/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.AsyncPlugin.setup.$2", - "type": "Uncategorized", - "tags": [], - "label": "plugins", - "description": [], - "signature": [ - "TPluginsSetup" - ], - "path": "src/core/server/plugins/types.ts", - "deprecated": false, - "isRequired": true - } + "signature": [ + "string[]" ], - "returnComment": [] + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.AsyncPlugin.start", - "type": "Function", + "id": "def-server.ElasticsearchConfig.requestHeadersWhitelist", + "type": "Array", "tags": [], - "label": "start", - "description": [], - "signature": [ - "(core: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreStart", - "text": "CoreStart" - }, - ", plugins: TPluginsStart) => TStart | Promise" + "label": "requestHeadersWhitelist", + "description": [ + "\nList of Kibana client-side headers to send to Elasticsearch when request\nscoped cluster client is used. If this is an empty array then *no* client-side\nwill be sent." ], - "path": "src/core/server/plugins/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.AsyncPlugin.start.$1", - "type": "Object", - "tags": [], - "label": "core", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreStart", - "text": "CoreStart" - } - ], - "path": "src/core/server/plugins/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.AsyncPlugin.start.$2", - "type": "Uncategorized", - "tags": [], - "label": "plugins", - "description": [], - "signature": [ - "TPluginsStart" - ], - "path": "src/core/server/plugins/types.ts", - "deprecated": false, - "isRequired": true - } + "signature": [ + "string[]" ], - "returnComment": [] + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.AsyncPlugin.stop", - "type": "Function", + "id": "def-server.ElasticsearchConfig.pingTimeout", + "type": "Object", "tags": [], - "label": "stop", - "description": [], + "label": "pingTimeout", + "description": [ + "\nTimeout after which PING HTTP request will be aborted and retried." + ], "signature": [ - "(() => void) | undefined" + "moment.Duration" ], - "path": "src/core/server/plugins/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.BaseDeprecationDetails", - "type": "Interface", - "tags": [], - "label": "BaseDeprecationDetails", - "description": [ - "\nBase properties shared by all types of deprecations\n" - ], - "path": "src/core/server/deprecations/types.ts", - "deprecated": false, - "children": [ + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "deprecated": false + }, { "parentPluginId": "core", - "id": "def-server.BaseDeprecationDetails.title", - "type": "string", + "id": "def-server.ElasticsearchConfig.requestTimeout", + "type": "Object", "tags": [], - "label": "title", + "label": "requestTimeout", "description": [ - "\nThe title of the deprecation.\nCheck the README for writing deprecations in `src/core/server/deprecations/README.mdx`" + "\nTimeout after which HTTP request will be aborted and retried." ], - "path": "src/core/server/deprecations/types.ts", + "signature": [ + "moment.Duration" + ], + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.BaseDeprecationDetails.message", - "type": "string", + "id": "def-server.ElasticsearchConfig.shardTimeout", + "type": "Object", "tags": [], - "label": "message", + "label": "shardTimeout", "description": [ - "\nThe description message to be displayed for the deprecation.\nCheck the README for writing deprecations in `src/core/server/deprecations/README.mdx`" + "\nTimeout for Elasticsearch to wait for responses from shards. Set to 0 to disable." ], - "path": "src/core/server/deprecations/types.ts", + "signature": [ + "moment.Duration" + ], + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.BaseDeprecationDetails.level", - "type": "CompoundType", + "id": "def-server.ElasticsearchConfig.sniffOnStart", + "type": "boolean", "tags": [], - "label": "level", + "label": "sniffOnStart", "description": [ - "\nlevels:\n- warning: will not break deployment upon upgrade\n- critical: needs to be addressed before upgrade.\n- fetch_error: Deprecations service failed to grab the deprecation details for the domain." - ], - "signature": [ - "\"warning\" | \"critical\" | \"fetch_error\"" + "\nSpecifies whether the client should attempt to detect the rest of the cluster\nwhen it is first instantiated." ], - "path": "src/core/server/deprecations/types.ts", + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.BaseDeprecationDetails.deprecationType", + "id": "def-server.ElasticsearchConfig.sniffInterval", "type": "CompoundType", "tags": [], - "label": "deprecationType", + "label": "sniffInterval", "description": [ - "\n(optional) Used to identify between different deprecation types.\nExample use case: in Upgrade Assistant, we may want to allow the user to sort by\ndeprecation type or show each type in a separate tab.\n\nFeel free to add new types if necessary.\nPredefined types are necessary to reduce having similar definitions with different keywords\nacross kibana deprecations." + "\nInterval to perform a sniff operation and make sure the list of nodes is complete.\nIf `false` then sniffing is disabled." ], "signature": [ - "\"config\" | \"feature\" | undefined" + "false | moment.Duration" ], - "path": "src/core/server/deprecations/types.ts", + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.BaseDeprecationDetails.documentationUrl", - "type": "string", + "id": "def-server.ElasticsearchConfig.sniffOnConnectionFault", + "type": "boolean", "tags": [], - "label": "documentationUrl", + "label": "sniffOnConnectionFault", "description": [ - "(optional) link to the documentation for more details on the deprecation." - ], - "signature": [ - "string | undefined" + "\nSpecifies whether the client should immediately sniff for a more current list\nof nodes when a connection dies." ], - "path": "src/core/server/deprecations/types.ts", + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.BaseDeprecationDetails.requireRestart", - "type": "CompoundType", + "id": "def-server.ElasticsearchConfig.username", + "type": "string", "tags": [], - "label": "requireRestart", + "label": "username", "description": [ - "(optional) specify the fix for this deprecation requires a full kibana restart." + "\nIf Elasticsearch is protected with basic authentication, this setting provides\nthe username that the Kibana server uses to perform its administrative functions.\nCannot be used in conjunction with serviceAccountToken." ], "signature": [ - "boolean | undefined" + "string | undefined" ], - "path": "src/core/server/deprecations/types.ts", + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.BaseDeprecationDetails.correctiveActions", - "type": "Object", + "id": "def-server.ElasticsearchConfig.password", + "type": "string", "tags": [], - "label": "correctiveActions", + "label": "password", "description": [ - "corrective action needed to fix this deprecation." + "\nIf Elasticsearch is protected with basic authentication, this setting provides\nthe password that the Kibana server uses to perform its administrative functions." ], "signature": [ - "{ api?: { path: string; method: \"POST\" | \"PUT\"; body?: { [key: string]: any; } | undefined; omitContextFromBody?: boolean | undefined; } | undefined; manualSteps: string[]; }" + "string | undefined" ], - "path": "src/core/server/deprecations/types.ts", + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.Capabilities", - "type": "Interface", - "tags": [], - "label": "Capabilities", - "description": [ - "\nThe read-only set of capabilities available for the current UI session.\nCapabilities are simple key-value pairs of (string, boolean), where the string denotes the capability ID,\nand the boolean is a flag indicating if the capability is enabled or disabled.\n" - ], - "path": "src/core/types/capabilities.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-server.Capabilities.navLinks", - "type": "Object", + "id": "def-server.ElasticsearchConfig.serviceAccountToken", + "type": "string", "tags": [], - "label": "navLinks", + "label": "serviceAccountToken", "description": [ - "Navigation link capabilities." + "\nIf Elasticsearch security features are enabled, this setting provides the service account\ntoken that the Kibana server users to perform its administrative functions.\n\nThis is an alternative to specifying a username and password." ], "signature": [ - "{ [x: string]: boolean; }" + "string | undefined" ], - "path": "src/core/types/capabilities.ts", + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.Capabilities.management", - "type": "Object", + "id": "def-server.ElasticsearchConfig.ssl", + "type": "CompoundType", "tags": [], - "label": "management", + "label": "ssl", "description": [ - "Management section capabilities." + "\nSet of settings configure SSL connection between Kibana and Elasticsearch that\nare required when `xpack.ssl.verification_mode` in Elasticsearch is set to\neither `certificate` or `full`." ], "signature": [ - "{ [sectionId: string]: Record; }" + "Pick; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>, \"key\" | \"verificationMode\" | \"certificate\" | \"keyPassphrase\" | \"alwaysPresentCertificate\"> & { certificateAuthorities?: string[] | undefined; }" ], - "path": "src/core/types/capabilities.ts", + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.Capabilities.catalogue", + "id": "def-server.ElasticsearchConfig.customHeaders", "type": "Object", "tags": [], - "label": "catalogue", + "label": "customHeaders", "description": [ - "Catalogue capabilities. Catalogue entries drive the visibility of the Kibana homepage options." + "\nHeader names and values to send to Elasticsearch with every request. These\nheaders cannot be overwritten by client-side headers and aren't affected by\n`requestHeadersWhitelist` configuration." ], "signature": [ - "{ [x: string]: boolean; }" + "{ [x: string]: string; }" ], - "path": "src/core/types/capabilities.ts", + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.Capabilities.Unnamed", - "type": "IndexSignature", + "id": "def-server.ElasticsearchConfig.Unnamed", + "type": "Function", "tags": [], - "label": "[key: string]: Record>", - "description": [ - "Custom capabilities, registered by plugins." - ], + "label": "Constructor", + "description": [], "signature": [ - "[key: string]: Record>" + "any" ], - "path": "src/core/types/capabilities.ts", - "deprecated": false + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchConfig.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "rawConfig", + "description": [], + "signature": [ + "Readonly<{ username?: string | undefined; password?: string | undefined; serviceAccountToken?: string | undefined; } & { ssl: Readonly<{ key?: string | undefined; certificateAuthorities?: string | string[] | undefined; certificate?: string | undefined; keyPassphrase?: string | undefined; } & { verificationMode: \"none\" | \"full\" | \"certificate\"; keystore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>; healthCheck: Readonly<{} & { delay: moment.Duration; }>; customHeaders: Record; hosts: string | string[]; sniffOnStart: boolean; sniffInterval: false | moment.Duration; sniffOnConnectionFault: boolean; maxSockets: number; compression: boolean; requestHeadersWhitelist: string | string[]; shardTimeout: moment.Duration; requestTimeout: moment.Duration; pingTimeout: moment.Duration; logQueries: boolean; apiVersion: string; ignoreVersionMismatch: boolean; skipStartupConnectionCheck: boolean; }>" + ], + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.CapabilitiesSetup", - "type": "Interface", + "id": "def-server.EventLoopDelaysMonitor", + "type": "Class", "tags": [], - "label": "CapabilitiesSetup", - "description": [ - "\nAPIs to manage the {@link Capabilities} that will be used by the application.\n\nPlugins relying on capabilities to toggle some of their features should register them during the setup phase\nusing the `registerProvider` method.\n\nPlugins having the responsibility to restrict capabilities depending on a given context should register\ntheir capabilities switcher using the `registerSwitcher` method.\n\nRefers to the methods documentation for complete description and examples.\n" - ], - "path": "src/core/server/capabilities/capabilities_service.ts", + "label": "EventLoopDelaysMonitor", + "description": [], + "path": "src/core/server/metrics/event_loop_delays/event_loop_delays_monitor.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.CapabilitiesSetup.registerProvider", + "id": "def-server.EventLoopDelaysMonitor.Unnamed", "type": "Function", "tags": [], - "label": "registerProvider", + "label": "Constructor", "description": [ - "\nRegister a {@link CapabilitiesProvider} to be used to provide {@link Capabilities}\nwhen resolving them.\n" + "\nCreating a new instance from EventLoopDelaysMonitor will\nautomatically start tracking event loop delays." ], "signature": [ - "(provider: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CapabilitiesProvider", - "text": "CapabilitiesProvider" - }, - ") => void" + "any" ], - "path": "src/core/server/capabilities/capabilities_service.ts", + "path": "src/core/server/metrics/event_loop_delays/event_loop_delays_monitor.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.CapabilitiesSetup.registerProvider.$1", - "type": "Function", - "tags": [], - "label": "provider", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CapabilitiesProvider", - "text": "CapabilitiesProvider" - } - ], - "path": "src/core/server/capabilities/capabilities_service.ts", - "deprecated": false, - "isRequired": true - } - ], + "children": [], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.CapabilitiesSetup.registerSwitcher", + "id": "def-server.EventLoopDelaysMonitor.collect", "type": "Function", "tags": [], - "label": "registerSwitcher", + "label": "collect", "description": [ - "\nRegister a {@link CapabilitiesSwitcher} to be used to change the default state\nof the {@link Capabilities} entries when resolving them.\n\nA capabilities switcher can only change the state of existing capabilities.\nCapabilities added or removed when invoking the switcher will be ignored.\n" + "\nCollect gathers event loop delays metrics from nodejs perf_hooks.monitorEventLoopDelay\nthe histogram calculations start from the last time `reset` was called or this\nEventLoopDelaysMonitor instance was created.\n\nReturns metrics in milliseconds." ], "signature": [ - "(switcher: ", + "() => ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.CapabilitiesSwitcher", - "text": "CapabilitiesSwitcher" - }, - ") => void" + "section": "def-server.IntervalHistogram", + "text": "IntervalHistogram" + } ], - "path": "src/core/server/capabilities/capabilities_service.ts", + "path": "src/core/server/metrics/event_loop_delays/event_loop_delays_monitor.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.CapabilitiesSetup.registerSwitcher.$1", - "type": "Function", - "tags": [], - "label": "switcher", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CapabilitiesSwitcher", - "text": "CapabilitiesSwitcher" - } - ], - "path": "src/core/server/capabilities/capabilities_service.ts", - "deprecated": false, - "isRequired": true - } + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.EventLoopDelaysMonitor.reset", + "type": "Function", + "tags": [], + "label": "reset", + "description": [ + "\nResets the collected histogram data." + ], + "signature": [ + "() => void" + ], + "path": "src/core/server/metrics/event_loop_delays/event_loop_delays_monitor.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.EventLoopDelaysMonitor.stop", + "type": "Function", + "tags": [], + "label": "stop", + "description": [ + "\nDisables updating the interval timer for collecting new data points." + ], + "signature": [ + "() => void" ], + "path": "src/core/server/metrics/event_loop_delays/event_loop_delays_monitor.ts", + "deprecated": false, + "children": [], "returnComment": [] } ], @@ -9805,88 +10548,59 @@ }, { "parentPluginId": "core", - "id": "def-server.CapabilitiesStart", - "type": "Interface", + "id": "def-server.RouteValidationError", + "type": "Class", "tags": [], - "label": "CapabilitiesStart", + "label": "RouteValidationError", "description": [ - "\nAPIs to access the application {@link Capabilities}.\n" + "\nError to return when the validation is not successful." ], - "path": "src/core/server/capabilities/capabilities_service.ts", + "signature": [ + "RouteValidationError", + " extends ", + "SchemaTypeError" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.CapabilitiesStart.resolveCapabilities", + "id": "def-server.RouteValidationError.Unnamed", "type": "Function", "tags": [], - "label": "resolveCapabilities", - "description": [ - "\nResolve the {@link Capabilities} to be used for given request" - ], + "label": "Constructor", + "description": [], "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ResolveCapabilitiesOptions", - "text": "ResolveCapabilitiesOptions" - }, - " | undefined) => Promise<", - "Capabilities", - ">" + "any" ], - "path": "src/core/server/capabilities/capabilities_service.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.CapabilitiesStart.resolveCapabilities.$1", - "type": "Object", + "id": "def-server.RouteValidationError.Unnamed.$1", + "type": "CompoundType", "tags": [], - "label": "request", + "label": "error", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" + "string | Error" ], - "path": "src/core/server/capabilities/capabilities_service.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.CapabilitiesStart.resolveCapabilities.$2", - "type": "Object", + "id": "def-server.RouteValidationError.Unnamed.$2", + "type": "Array", "tags": [], - "label": "options", + "label": "path", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ResolveCapabilitiesOptions", - "text": "ResolveCapabilitiesOptions" - }, - " | undefined" + "string[] | undefined" ], - "path": "src/core/server/capabilities/capabilities_service.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "isRequired": false } @@ -9895,183 +10609,122 @@ } ], "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.ConfigDeprecationContext", - "type": "Interface", - "tags": [], - "label": "ConfigDeprecationContext", - "description": [ - "\nDeprecation context provided to {@link ConfigDeprecation | config deprecations}\n" - ], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.ConfigDeprecationContext.version", - "type": "string", - "tags": [], - "label": "version", - "description": [ - "The current Kibana version, e.g `7.16.1`, `8.0.0`" - ], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.ConfigDeprecationContext.branch", - "type": "string", - "tags": [], - "label": "branch", - "description": [ - "The current Kibana branch, e.g `7.x`, `7.16`, `master`" - ], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.ConfigDeprecationContext.docLinks", - "type": "Object", - "tags": [], - "label": "docLinks", - "description": [ - "Allow direct access to the doc links from the deprecation handler" - ], - "signature": [ - "DocLinks" - ], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, + } + ], + "functions": [ { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationDetails", - "type": "Interface", + "id": "def-server.pollEsNodesVersion", + "type": "Function", "tags": [], - "label": "ConfigDeprecationDetails", + "label": "pollEsNodesVersion", "description": [], "signature": [ + "({ internalClient, log, kibanaVersion, ignoreVersionMismatch, esVersionCheckInterval: healthCheckInterval, }: ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.ConfigDeprecationDetails", - "text": "ConfigDeprecationDetails" + "section": "def-server.PollEsNodesVersionOptions", + "text": "PollEsNodesVersionOptions" }, - " extends ", + ") => ", + "Observable", + "<", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.BaseDeprecationDetails", - "text": "BaseDeprecationDetails" - } + "section": "def-server.NodesVersionCompatibility", + "text": "NodesVersionCompatibility" + }, + ">" ], - "path": "src/core/server/deprecations/types.ts", + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationDetails.configPath", - "type": "string", - "tags": [], - "label": "configPath", - "description": [], - "path": "src/core/server/deprecations/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.ConfigDeprecationDetails.deprecationType", - "type": "string", + "id": "def-server.pollEsNodesVersion.$1", + "type": "Object", "tags": [], - "label": "deprecationType", + "label": "{\n internalClient,\n log,\n kibanaVersion,\n ignoreVersionMismatch,\n esVersionCheckInterval: healthCheckInterval,\n}", "description": [], "signature": [ - "\"config\"" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.PollEsNodesVersionOptions", + "text": "PollEsNodesVersionOptions" + } ], - "path": "src/core/server/deprecations/types.ts", - "deprecated": false + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "deprecated": false, + "isRequired": true } ], + "returnComment": [], "initialIsOpen": false - }, + } + ], + "interfaces": [ { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory", + "id": "def-server.AnalyticsClient", "type": "Interface", "tags": [], - "label": "ConfigDeprecationFactory", + "label": "AnalyticsClient", "description": [ - "\nProvides helpers to generates the most commonly used {@link ConfigDeprecation}\nwhen invoking a {@link ConfigDeprecationProvider}.\n\nSee methods documentation for more detailed examples.\n" + "\nAnalytics client's public APIs" ], - "path": "node_modules/@types/kbn__config/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.deprecate", + "id": "def-server.AnalyticsClient.reportEvent", "type": "Function", "tags": [], - "label": "deprecate", + "label": "reportEvent", "description": [ - "\nDeprecate a configuration property from inside a plugin's configuration path.\nWill log a deprecation warning if the deprecatedKey was found.\n" + "\nReports a telemetry event." ], "signature": [ - "(deprecatedKey: string, removeBy: string, details: ", - "FactoryConfigDeprecationDetails", - ") => ", - "ConfigDeprecation" + ">(eventType: string, eventData: EventTypeData) => void" ], - "path": "node_modules/@types/kbn__config/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.deprecate.$1", + "id": "def-server.AnalyticsClient.reportEvent.$1", "type": "string", "tags": [], - "label": "deprecatedKey", - "description": [], - "signature": [ - "string" + "label": "eventType", + "description": [ + "The event type registered via the `registerEventType` API." ], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.deprecate.$2", - "type": "string", - "tags": [], - "label": "removeBy", - "description": [], "signature": [ "string" ], - "path": "node_modules/@types/kbn__config/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.deprecate.$3", - "type": "CompoundType", + "id": "def-server.AnalyticsClient.reportEvent.$2", + "type": "Uncategorized", "tags": [], - "label": "details", - "description": [], + "label": "eventData", + "description": [ + "The properties matching the schema declared in the `registerEventType` API." + ], "signature": [ - "FactoryConfigDeprecationDetails" + "EventTypeData" ], - "path": "node_modules/@types/kbn__config/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true } @@ -10080,61 +10733,35 @@ }, { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.deprecateFromRoot", + "id": "def-server.AnalyticsClient.registerEventType", "type": "Function", "tags": [], - "label": "deprecateFromRoot", + "label": "registerEventType", "description": [ - "\nDeprecate a configuration property from the root configuration.\nWill log a deprecation warning if the deprecatedKey was found.\n\nThis should be only used when deprecating properties from different configuration's path.\nTo deprecate properties from inside a plugin's configuration, use 'deprecate' instead.\n" + "\nRegisters the event type that will be emitted via the reportEvent API." ], "signature": [ - "(deprecatedKey: string, removeBy: string, details: ", - "FactoryConfigDeprecationDetails", - ") => ", - "ConfigDeprecation" + "(eventTypeOps: ", + "EventTypeOpts", + ") => void" ], - "path": "node_modules/@types/kbn__config/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.deprecateFromRoot.$1", - "type": "string", + "id": "def-server.AnalyticsClient.registerEventType.$1", + "type": "Object", "tags": [], - "label": "deprecatedKey", - "description": [], + "label": "eventTypeOps", + "description": [ + "The definition of the event type {@link EventTypeOpts }." + ], "signature": [ - "string" + "EventTypeOpts", + "" ], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.deprecateFromRoot.$2", - "type": "string", - "tags": [], - "label": "removeBy", - "description": [], - "signature": [ - "string" - ], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.deprecateFromRoot.$3", - "type": "CompoundType", - "tags": [], - "label": "details", - "description": [], - "signature": [ - "FactoryConfigDeprecationDetails" - ], - "path": "node_modules/@types/kbn__config/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true } @@ -10143,124 +10770,108 @@ }, { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.rename", + "id": "def-server.AnalyticsClient.registerShipper", "type": "Function", "tags": [], - "label": "rename", + "label": "registerShipper", "description": [ - "\nRename a configuration property from inside a plugin's configuration path.\nWill log a deprecation warning if the oldKey was found and deprecation applied.\n" + "\nSet up the shipper that will be used to report the telemetry events." ], "signature": [ - "(oldKey: string, newKey: string, details: ", - "FactoryConfigDeprecationDetails", - ") => ", - "ConfigDeprecation" + "(Shipper: ", + "ShipperClassConstructor", + ", shipperConfig: ShipperConfig, opts?: ", + "RegisterShipperOpts", + " | undefined) => void" ], - "path": "node_modules/@types/kbn__config/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.rename.$1", - "type": "string", + "id": "def-server.AnalyticsClient.registerShipper.$1", + "type": "Object", "tags": [], - "label": "oldKey", - "description": [], + "label": "Shipper", + "description": [ + "The {@link IShipper } class to instantiate the shipper." + ], "signature": [ - "string" + "ShipperClassConstructor", + "" ], - "path": "node_modules/@types/kbn__config/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.rename.$2", - "type": "string", + "id": "def-server.AnalyticsClient.registerShipper.$2", + "type": "Uncategorized", "tags": [], - "label": "newKey", - "description": [], + "label": "shipperConfig", + "description": [ + "The config specific to the Shipper to instantiate." + ], "signature": [ - "string" + "ShipperConfig" ], - "path": "node_modules/@types/kbn__config/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.rename.$3", - "type": "CompoundType", + "id": "def-server.AnalyticsClient.registerShipper.$3", + "type": "Object", "tags": [], - "label": "details", - "description": [], + "label": "opts", + "description": [ + "Additional options to register the shipper {@link RegisterShipperOpts }." + ], "signature": [ - "FactoryConfigDeprecationDetails" + "RegisterShipperOpts", + " | undefined" ], - "path": "node_modules/@types/kbn__config/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, - "isRequired": true + "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.renameFromRoot", + "id": "def-server.AnalyticsClient.optIn", "type": "Function", "tags": [], - "label": "renameFromRoot", + "label": "optIn", "description": [ - "\nRename a configuration property from the root configuration.\nWill log a deprecation warning if the oldKey was found and deprecation applied.\n\nThis should be only used when renaming properties from different configuration's path.\nTo rename properties from inside a plugin's configuration, use 'rename' instead.\n" + "\nUsed to control the user's consent to report the data.\nIn the advanced mode, it allows to \"cherry-pick\" which events and shippers are enabled/disabled." ], "signature": [ - "(oldKey: string, newKey: string, details: ", - "FactoryConfigDeprecationDetails", - ") => ", - "ConfigDeprecation" + "(optInConfig: ", + "OptInConfig", + ") => void" ], - "path": "node_modules/@types/kbn__config/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.renameFromRoot.$1", - "type": "string", - "tags": [], - "label": "oldKey", - "description": [], - "signature": [ - "string" - ], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.renameFromRoot.$2", - "type": "string", + "id": "def-server.AnalyticsClient.optIn.$1", + "type": "Object", "tags": [], - "label": "newKey", - "description": [], - "signature": [ - "string" + "label": "optInConfig", + "description": [ + "{@link OptInConfig }" ], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.renameFromRoot.$3", - "type": "CompoundType", - "tags": [], - "label": "details", - "description": [], "signature": [ - "FactoryConfigDeprecationDetails" + "OptInConfig" ], - "path": "node_modules/@types/kbn__config/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true } @@ -10269,47 +10880,35 @@ }, { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.unused", + "id": "def-server.AnalyticsClient.registerContextProvider", "type": "Function", "tags": [], - "label": "unused", + "label": "registerContextProvider", "description": [ - "\nRemove a configuration property from inside a plugin's configuration path.\nWill log a deprecation warning if the unused key was found and deprecation applied.\n" + "\nRegisters the context provider to enrich the any reported events." ], "signature": [ - "(unusedKey: string, details: ", - "FactoryConfigDeprecationDetails", - ") => ", - "ConfigDeprecation" + "(contextProviderOpts: ", + "ContextProviderOpts", + ") => void" ], - "path": "node_modules/@types/kbn__config/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.unused.$1", - "type": "string", + "id": "def-server.AnalyticsClient.registerContextProvider.$1", + "type": "Object", "tags": [], - "label": "unusedKey", - "description": [], - "signature": [ - "string" + "label": "contextProviderOpts", + "description": [ + "{@link ContextProviderOpts }" ], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.unused.$2", - "type": "CompoundType", - "tags": [], - "label": "details", - "description": [], "signature": [ - "FactoryConfigDeprecationDetails" + "ContextProviderOpts", + "" ], - "path": "node_modules/@types/kbn__config/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true } @@ -10318,233 +10917,155 @@ }, { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.unusedFromRoot", + "id": "def-server.AnalyticsClient.removeContextProvider", "type": "Function", "tags": [], - "label": "unusedFromRoot", + "label": "removeContextProvider", "description": [ - "\nRemove a configuration property from the root configuration.\nWill log a deprecation warning if the unused key was found and deprecation applied.\n\nThis should be only used when removing properties from outside of a plugin's configuration.\nTo remove properties from inside a plugin's configuration, use 'unused' instead.\n" + "\nRemoves the context provider and stop enriching the events from its context." ], "signature": [ - "(unusedKey: string, details: ", - "FactoryConfigDeprecationDetails", - ") => ", - "ConfigDeprecation" + "(contextProviderName: string) => void" ], - "path": "node_modules/@types/kbn__config/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.unusedFromRoot.$1", + "id": "def-server.AnalyticsClient.removeContextProvider.$1", "type": "string", "tags": [], - "label": "unusedKey", - "description": [], - "signature": [ - "string" + "label": "contextProviderName", + "description": [ + "The name of the context provider to remove." ], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.unusedFromRoot.$2", - "type": "CompoundType", - "tags": [], - "label": "details", - "description": [], "signature": [ - "FactoryConfigDeprecationDetails" + "string" ], - "path": "node_modules/@types/kbn__config/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.ContextProviderOpts", - "type": "Interface", - "tags": [], - "label": "ContextProviderOpts", - "description": [ - "\nDefinition of a context provider" - ], - "signature": [ - "ContextProviderOpts", - "" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-server.ContextProviderOpts.name", - "type": "string", + "id": "def-server.AnalyticsClient.telemetryCounter$", + "type": "Object", "tags": [], - "label": "name", + "label": "telemetryCounter$", "description": [ - "\nThe name of the provider." + "\nObservable to emit the stats of the processed events." + ], + "signature": [ + "Observable", + "<", + "TelemetryCounter", + ">" ], "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.ContextProviderOpts.context$", - "type": "Object", + "id": "def-server.AnalyticsClient.shutdown", + "type": "Function", "tags": [], - "label": "context$", - "description": [ - "\nObservable that emits the custom context." - ], - "signature": [ - "Observable", - "" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.ContextProviderOpts.schema", - "type": "Object", - "tags": [], - "label": "schema", + "label": "shutdown", "description": [ - "\nSchema declaring and documenting the expected output in the context$\n" + "\nStops the client." ], "signature": [ - "{ [Key in keyof Required]: ", - "SchemaValue", - "; }" + "() => void" ], "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.CorePreboot", + "id": "def-server.AppCategory", "type": "Interface", "tags": [], - "label": "CorePreboot", + "label": "AppCategory", "description": [ - "\nContext passed to the `setup` method of `preboot` plugins." + "\n\nA category definition for nav links to know where to sort them in the left hand nav" ], - "path": "src/core/server/index.ts", + "path": "src/core/types/app_category.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.CorePreboot.analytics", - "type": "Object", + "id": "def-server.AppCategory.id", + "type": "string", "tags": [], - "label": "analytics", + "label": "id", "description": [ - "{@link AnalyticsServicePreboot}" + "\nUnique identifier for the categories" ], - "signature": [ - "{ optIn: (optInConfig: ", - "OptInConfig", - ") => void; reportEvent: >(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ", - "Observable", - "<", - "TelemetryCounter", - ">; registerEventType: (eventTypeOps: ", - "EventTypeOpts", - ") => void; registerShipper: (Shipper: ", - "ShipperClassConstructor", - ", shipperConfig: ShipperConfig, opts?: ", - "RegisterShipperOpts", - " | undefined) => void; registerContextProvider: (contextProviderOpts: ", - "ContextProviderOpts", - ") => void; removeContextProvider: (contextProviderName: string) => void; }" + "path": "src/core/types/app_category.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.AppCategory.label", + "type": "string", + "tags": [], + "label": "label", + "description": [ + "\nLabel used for category name.\nAlso used as aria-label if one isn't set." ], - "path": "src/core/server/index.ts", + "path": "src/core/types/app_category.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.CorePreboot.elasticsearch", - "type": "Object", + "id": "def-server.AppCategory.ariaLabel", + "type": "string", "tags": [], - "label": "elasticsearch", + "label": "ariaLabel", "description": [ - "{@link ElasticsearchServicePreboot}" + "\nIf the visual label isn't appropriate for screen readers,\ncan override it here" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchServicePreboot", - "text": "ElasticsearchServicePreboot" - } + "string | undefined" ], - "path": "src/core/server/index.ts", + "path": "src/core/types/app_category.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.CorePreboot.http", - "type": "Object", + "id": "def-server.AppCategory.order", + "type": "number", "tags": [], - "label": "http", + "label": "order", "description": [ - "{@link HttpServicePreboot}" + "\nThe order that categories will be sorted in\nPrefer large steps between categories to allow for further editing\n(Default categories are in steps of 1000)" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpServicePreboot", - "text": "HttpServicePreboot" - }, - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.RequestHandlerContext", - "text": "RequestHandlerContext" - }, - ">" + "number | undefined" ], - "path": "src/core/server/index.ts", + "path": "src/core/types/app_category.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.CorePreboot.preboot", - "type": "Object", + "id": "def-server.AppCategory.euiIconType", + "type": "string", "tags": [], - "label": "preboot", + "label": "euiIconType", "description": [ - "{@link PrebootServicePreboot}" + "\nDefine an icon to be used for the category\nIf the category is only 1 item, and no icon is defined, will default to the product icon\nDefaults to initials if no icon is defined" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.PrebootServicePreboot", - "text": "PrebootServicePreboot" - } + "string | undefined" ], - "path": "src/core/server/index.ts", + "path": "src/core/types/app_category.ts", "deprecated": false } ], @@ -10552,740 +11073,878 @@ }, { "parentPluginId": "core", - "id": "def-server.CoreRequestHandlerContext", + "id": "def-server.AsyncPlugin", "type": "Interface", - "tags": [], - "label": "CoreRequestHandlerContext", + "tags": [ + "deprecated" + ], + "label": "AsyncPlugin", "description": [ - "\nThe `core` context provided to route handler.\n\nProvides the following clients and services:\n - {@link SavedObjectsClient | savedObjects.client} - Saved Objects client\n which uses the credentials of the incoming request\n - {@link ISavedObjectTypeRegistry | savedObjects.typeRegistry} - Type registry containing\n all the registered types.\n - {@link IScopedClusterClient | elasticsearch.client} - Elasticsearch\n data client which uses the credentials of the incoming request\n - {@link IUiSettingsClient | uiSettings.client} - uiSettings client\n which uses the credentials of the incoming request" + "\nA plugin with asynchronous lifecycle methods.\n" ], - "path": "src/core/server/core_route_handler_context.ts", - "deprecated": false, - "children": [ + "signature": [ { - "parentPluginId": "core", - "id": "def-server.CoreRequestHandlerContext.savedObjects", - "type": "Object", - "tags": [], - "label": "savedObjects", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRequestHandlerContext", - "text": "SavedObjectsRequestHandlerContext" - } - ], - "path": "src/core/server/core_route_handler_context.ts", - "deprecated": false + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.AsyncPlugin", + "text": "AsyncPlugin" }, + "" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": true, + "removeBy": "8.8.0", + "references": [], + "children": [ { "parentPluginId": "core", - "id": "def-server.CoreRequestHandlerContext.elasticsearch", - "type": "Object", + "id": "def-server.AsyncPlugin.setup", + "type": "Function", "tags": [], - "label": "elasticsearch", + "label": "setup", "description": [], "signature": [ + "(core: ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchRequestHandlerContext", - "text": "ElasticsearchRequestHandlerContext" - } + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + ", plugins: TPluginsSetup) => TSetup | Promise" ], - "path": "src/core/server/core_route_handler_context.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.CoreRequestHandlerContext.uiSettings", - "type": "Object", - "tags": [], - "label": "uiSettings", - "description": [], - "signature": [ + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.UiSettingsRequestHandlerContext", - "text": "UiSettingsRequestHandlerContext" + "parentPluginId": "core", + "id": "def-server.AsyncPlugin.setup.$1", + "type": "Object", + "tags": [], + "label": "core", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + "" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.AsyncPlugin.setup.$2", + "type": "Uncategorized", + "tags": [], + "label": "plugins", + "description": [], + "signature": [ + "TPluginsSetup" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "isRequired": true } ], - "path": "src/core/server/core_route_handler_context.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.CoreRequestHandlerContext.deprecations", - "type": "Object", + "id": "def-server.AsyncPlugin.start", + "type": "Function", "tags": [], - "label": "deprecations", + "label": "start", "description": [], "signature": [ + "(core: ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.DeprecationsRequestHandlerContext", - "text": "DeprecationsRequestHandlerContext" - } - ], - "path": "src/core/server/core_route_handler_context.ts", - "deprecated": false + "section": "def-server.CoreStart", + "text": "CoreStart" + }, + ", plugins: TPluginsStart) => TStart | Promise" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.AsyncPlugin.start.$1", + "type": "Object", + "tags": [], + "label": "core", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + } + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.AsyncPlugin.start.$2", + "type": "Uncategorized", + "tags": [], + "label": "plugins", + "description": [], + "signature": [ + "TPluginsStart" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.AsyncPlugin.stop", + "type": "Function", + "tags": [], + "label": "stop", + "description": [], + "signature": [ + "(() => void) | undefined" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.CoreSetup", + "id": "def-server.AuthRedirectedParams", "type": "Interface", "tags": [], - "label": "CoreSetup", + "label": "AuthRedirectedParams", "description": [ - "\nContext passed to the `setup` method of `standard` plugins.\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreSetup", - "text": "CoreSetup" - }, - "" + "\nResult of auth redirection." ], - "path": "src/core/server/index.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.CoreSetup.analytics", - "type": "Object", + "id": "def-server.AuthRedirectedParams.headers", + "type": "CompoundType", "tags": [], - "label": "analytics", + "label": "headers", "description": [ - "{@link AnalyticsServiceSetup}" + "\nHeaders to attach for auth redirect.\nMust include \"location\" header" ], "signature": [ - "{ optIn: (optInConfig: ", - "OptInConfig", - ") => void; reportEvent: >(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ", - "Observable", - "<", - "TelemetryCounter", - ">; registerEventType: (eventTypeOps: ", - "EventTypeOpts", - ") => void; registerShipper: (Shipper: ", - "ShipperClassConstructor", - ", shipperConfig: ShipperConfig, opts?: ", - "RegisterShipperOpts", - " | undefined) => void; registerContextProvider: (contextProviderOpts: ", - "ContextProviderOpts", - ") => void; removeContextProvider: (contextProviderName: string) => void; }" + "{ location: string; } & ", + "ResponseHeaders" ], - "path": "src/core/server/index.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.AuthResultAuthenticated", + "type": "Interface", + "tags": [], + "label": "AuthResultAuthenticated", + "description": [], + "signature": [ + "AuthResultAuthenticated", + " extends ", + "AuthResultParams" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.CoreSetup.capabilities", - "type": "Object", + "id": "def-server.AuthResultAuthenticated.type", + "type": "string", "tags": [], - "label": "capabilities", - "description": [ - "{@link CapabilitiesSetup}" + "label": "type", + "description": [], + "signature": [ + "AuthResultType", + ".authenticated" ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.AuthResultNotHandled", + "type": "Interface", + "tags": [], + "label": "AuthResultNotHandled", + "description": [], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.AuthResultNotHandled.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CapabilitiesSetup", - "text": "CapabilitiesSetup" - } + "AuthResultType", + ".notHandled" ], - "path": "src/core/server/index.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.AuthResultParams", + "type": "Interface", + "tags": [], + "label": "AuthResultParams", + "description": [ + "\nResult of successful authentication." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.CoreSetup.docLinks", + "id": "def-server.AuthResultParams.state", "type": "Object", "tags": [], - "label": "docLinks", + "label": "state", "description": [ - "{@link DocLinksServiceSetup}" + "\nData to associate with an incoming request. Any downstream plugin may get access to the data." ], "signature": [ - "DocLinksServiceSetup" + "Record | undefined" ], - "path": "src/core/server/index.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.CoreSetup.elasticsearch", + "id": "def-server.AuthResultParams.requestHeaders", "type": "Object", "tags": [], - "label": "elasticsearch", + "label": "requestHeaders", "description": [ - "{@link ElasticsearchServiceSetup}" + "\nAuth specific headers to attach to a request object.\nUsed to perform a request to Elasticsearch on behalf of an authenticated user." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchServiceSetup", - "text": "ElasticsearchServiceSetup" - } + "AuthHeaders", + " | undefined" ], - "path": "src/core/server/index.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.CoreSetup.executionContext", + "id": "def-server.AuthResultParams.responseHeaders", "type": "Object", "tags": [], - "label": "executionContext", + "label": "responseHeaders", "description": [ - "{@link ExecutionContextSetup}" + "\nAuth specific headers to attach to a response object.\nUsed to send back authentication mechanism related headers to a client when needed." ], "signature": [ - "ExecutionContextSetup" + "AuthHeaders", + " | undefined" ], - "path": "src/core/server/index.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.AuthResultRedirected", + "type": "Interface", + "tags": [], + "label": "AuthResultRedirected", + "description": [], + "signature": [ + "AuthResultRedirected", + " extends ", + "AuthRedirectedParams" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.CoreSetup.http", - "type": "CompoundType", + "id": "def-server.AuthResultRedirected.type", + "type": "string", "tags": [], - "label": "http", - "description": [ - "{@link HttpServiceSetup}" - ], + "label": "type", + "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpServiceSetup", - "text": "HttpServiceSetup" - }, - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.RequestHandlerContext", - "text": "RequestHandlerContext" - }, - "> & { resources: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.HttpResources", - "text": "HttpResources" - }, - "; }" + "AuthResultType", + ".redirected" ], - "path": "src/core/server/index.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.AuthToolkit", + "type": "Interface", + "tags": [], + "label": "AuthToolkit", + "description": [], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.CoreSetup.i18n", - "type": "Object", + "id": "def-server.AuthToolkit.authenticated", + "type": "Function", "tags": [], - "label": "i18n", + "label": "authenticated", "description": [ - "{@link I18nServiceSetup}" + "Authentication is successful with given credentials, allow request to pass through" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.I18nServiceSetup", - "text": "I18nServiceSetup" - } + "(data?: ", + "AuthResultParams", + " | undefined) => ", + "AuthResult" ], - "path": "src/core/server/index.ts", - "deprecated": false + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.AuthToolkit.authenticated.$1", + "type": "Object", + "tags": [], + "label": "data", + "description": [], + "signature": [ + "AuthResultParams", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.CoreSetup.logging", - "type": "Object", + "id": "def-server.AuthToolkit.notHandled", + "type": "Function", "tags": [], - "label": "logging", + "label": "notHandled", "description": [ - "{@link LoggingServiceSetup}" + "\nUser has no credentials.\nAllows user to access a resource when authRequired is 'optional'\nRejects a request when authRequired: true" ], "signature": [ - "LoggingServiceSetup" + "() => ", + "AuthResult" ], - "path": "src/core/server/index.ts", - "deprecated": false + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.CoreSetup.metrics", - "type": "Object", + "id": "def-server.AuthToolkit.redirected", + "type": "Function", "tags": [], - "label": "metrics", + "label": "redirected", "description": [ - "{@link MetricsServiceSetup}" + "\nRedirects user to another location to complete authentication when authRequired: true\nAllows user to access a resource without redirection when authRequired: 'optional'" ], "signature": [ + "(headers: { location: string; } & ", + "ResponseHeaders", + ") => ", + "AuthResult" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.MetricsServiceSetup", - "text": "MetricsServiceSetup" + "parentPluginId": "core", + "id": "def-server.AuthToolkit.redirected.$1", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [], + "signature": [ + "{ location: string; } & ", + "ResponseHeaders" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true } ], - "path": "src/core/server/index.ts", + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.BaseDeprecationDetails", + "type": "Interface", + "tags": [], + "label": "BaseDeprecationDetails", + "description": [ + "\nBase properties shared by all types of deprecations\n" + ], + "path": "src/core/server/deprecations/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.BaseDeprecationDetails.title", + "type": "string", + "tags": [], + "label": "title", + "description": [ + "\nThe title of the deprecation.\nCheck the README for writing deprecations in `src/core/server/deprecations/README.mdx`" + ], + "path": "src/core/server/deprecations/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.CoreSetup.savedObjects", - "type": "Object", + "id": "def-server.BaseDeprecationDetails.message", + "type": "string", "tags": [], - "label": "savedObjects", + "label": "message", "description": [ - "{@link SavedObjectsServiceSetup}" + "\nThe description message to be displayed for the deprecation.\nCheck the README for writing deprecations in `src/core/server/deprecations/README.mdx`" + ], + "path": "src/core/server/deprecations/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.BaseDeprecationDetails.level", + "type": "CompoundType", + "tags": [], + "label": "level", + "description": [ + "\nlevels:\n- warning: will not break deployment upon upgrade\n- critical: needs to be addressed before upgrade.\n- fetch_error: Deprecations service failed to grab the deprecation details for the domain." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsServiceSetup", - "text": "SavedObjectsServiceSetup" - } + "\"warning\" | \"critical\" | \"fetch_error\"" ], - "path": "src/core/server/index.ts", + "path": "src/core/server/deprecations/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.CoreSetup.status", - "type": "Object", + "id": "def-server.BaseDeprecationDetails.deprecationType", + "type": "CompoundType", "tags": [], - "label": "status", + "label": "deprecationType", "description": [ - "{@link StatusServiceSetup}" + "\n(optional) Used to identify between different deprecation types.\nExample use case: in Upgrade Assistant, we may want to allow the user to sort by\ndeprecation type or show each type in a separate tab.\n\nFeel free to add new types if necessary.\nPredefined types are necessary to reduce having similar definitions with different keywords\nacross kibana deprecations." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.StatusServiceSetup", - "text": "StatusServiceSetup" - } + "\"config\" | \"feature\" | undefined" ], - "path": "src/core/server/index.ts", + "path": "src/core/server/deprecations/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.CoreSetup.uiSettings", - "type": "Object", + "id": "def-server.BaseDeprecationDetails.documentationUrl", + "type": "string", "tags": [], - "label": "uiSettings", + "label": "documentationUrl", "description": [ - "{@link UiSettingsServiceSetup}" + "(optional) link to the documentation for more details on the deprecation." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.UiSettingsServiceSetup", - "text": "UiSettingsServiceSetup" - } + "string | undefined" ], - "path": "src/core/server/index.ts", + "path": "src/core/server/deprecations/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.CoreSetup.deprecations", - "type": "Object", + "id": "def-server.BaseDeprecationDetails.requireRestart", + "type": "CompoundType", "tags": [], - "label": "deprecations", + "label": "requireRestart", "description": [ - "{@link DeprecationsServiceSetup}" + "(optional) specify the fix for this deprecation requires a full kibana restart." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.DeprecationsServiceSetup", - "text": "DeprecationsServiceSetup" - } + "boolean | undefined" ], - "path": "src/core/server/index.ts", + "path": "src/core/server/deprecations/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.CoreSetup.getStartServices", - "type": "Function", + "id": "def-server.BaseDeprecationDetails.correctiveActions", + "type": "Object", "tags": [], - "label": "getStartServices", + "label": "correctiveActions", "description": [ - "{@link StartServicesAccessor}" + "corrective action needed to fix this deprecation." ], "signature": [ - "() => Promise<[", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreStart", - "text": "CoreStart" - }, - ", TPluginsStart, TStart]>" + "{ api?: { path: string; method: \"POST\" | \"PUT\"; body?: { [key: string]: any; } | undefined; omitContextFromBody?: boolean | undefined; } | undefined; manualSteps: string[]; }" ], - "path": "src/core/server/index.ts", - "deprecated": false, - "returnComment": [], - "children": [] + "path": "src/core/server/deprecations/types.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.CoreStart", + "id": "def-server.Capabilities", "type": "Interface", "tags": [], - "label": "CoreStart", + "label": "Capabilities", "description": [ - "\nContext passed to the plugins `start` method.\n" + "\nThe read-only set of capabilities available for the current UI session.\nCapabilities are simple key-value pairs of (string, boolean), where the string denotes the capability ID,\nand the boolean is a flag indicating if the capability is enabled or disabled.\n" ], - "path": "src/core/server/index.ts", + "path": "src/core/types/capabilities.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.CoreStart.analytics", + "id": "def-server.Capabilities.navLinks", "type": "Object", "tags": [], - "label": "analytics", + "label": "navLinks", "description": [ - "{@link AnalyticsServiceStart}" + "Navigation link capabilities." ], "signature": [ - "{ optIn: (optInConfig: ", - "OptInConfig", - ") => void; reportEvent: >(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ", - "Observable", - "<", - "TelemetryCounter", - ">; }" + "{ [x: string]: boolean; }" ], - "path": "src/core/server/index.ts", + "path": "src/core/types/capabilities.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.CoreStart.capabilities", + "id": "def-server.Capabilities.management", "type": "Object", "tags": [], - "label": "capabilities", + "label": "management", "description": [ - "{@link CapabilitiesStart}" + "Management section capabilities." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CapabilitiesStart", - "text": "CapabilitiesStart" - } + "{ [sectionId: string]: Record; }" ], - "path": "src/core/server/index.ts", + "path": "src/core/types/capabilities.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.CoreStart.docLinks", + "id": "def-server.Capabilities.catalogue", "type": "Object", "tags": [], - "label": "docLinks", + "label": "catalogue", "description": [ - "{@link DocLinksServiceStart}" + "Catalogue capabilities. Catalogue entries drive the visibility of the Kibana homepage options." ], "signature": [ - "DocLinksServiceSetup" + "{ [x: string]: boolean; }" ], - "path": "src/core/server/index.ts", + "path": "src/core/types/capabilities.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.CoreStart.elasticsearch", - "type": "Object", + "id": "def-server.Capabilities.Unnamed", + "type": "IndexSignature", "tags": [], - "label": "elasticsearch", + "label": "[key: string]: Record>", "description": [ - "{@link ElasticsearchServiceStart}" + "Custom capabilities, registered by plugins." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchServiceStart", - "text": "ElasticsearchServiceStart" - } + "[key: string]: Record>" ], - "path": "src/core/server/index.ts", + "path": "src/core/types/capabilities.ts", "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.CoreStart.executionContext", - "type": "Object", - "tags": [], - "label": "executionContext", - "description": [ - "{@link ExecutionContextStart}" - ], - "signature": [ - "ExecutionContextSetup" - ], - "path": "src/core/server/index.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.CoreStart.http", - "type": "Object", - "tags": [], - "label": "http", - "description": [ - "{@link HttpServiceStart}" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpServiceStart", - "text": "HttpServiceStart" - } - ], - "path": "src/core/server/index.ts", - "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.CapabilitiesSetup", + "type": "Interface", + "tags": [], + "label": "CapabilitiesSetup", + "description": [ + "\nAPIs to manage the {@link Capabilities} that will be used by the application.\n\nPlugins relying on capabilities to toggle some of their features should register them during the setup phase\nusing the `registerProvider` method.\n\nPlugins having the responsibility to restrict capabilities depending on a given context should register\ntheir capabilities switcher using the `registerSwitcher` method.\n\nRefers to the methods documentation for complete description and examples.\n" + ], + "path": "src/core/server/capabilities/capabilities_service.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.CoreStart.metrics", - "type": "Object", + "id": "def-server.CapabilitiesSetup.registerProvider", + "type": "Function", "tags": [], - "label": "metrics", + "label": "registerProvider", "description": [ - "{@link MetricsServiceStart}" + "\nRegister a {@link CapabilitiesProvider} to be used to provide {@link Capabilities}\nwhen resolving them.\n" ], "signature": [ + "(provider: ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.MetricsServiceSetup", - "text": "MetricsServiceSetup" - } - ], - "path": "src/core/server/index.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.CoreStart.savedObjects", - "type": "Object", - "tags": [], - "label": "savedObjects", - "description": [ - "{@link SavedObjectsServiceStart}" + "section": "def-server.CapabilitiesProvider", + "text": "CapabilitiesProvider" + }, + ") => void" ], - "signature": [ + "path": "src/core/server/capabilities/capabilities_service.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsServiceStart", - "text": "SavedObjectsServiceStart" + "parentPluginId": "core", + "id": "def-server.CapabilitiesSetup.registerProvider.$1", + "type": "Function", + "tags": [], + "label": "provider", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CapabilitiesProvider", + "text": "CapabilitiesProvider" + } + ], + "path": "src/core/server/capabilities/capabilities_service.ts", + "deprecated": false, + "isRequired": true } ], - "path": "src/core/server/index.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.CoreStart.uiSettings", - "type": "Object", + "id": "def-server.CapabilitiesSetup.registerSwitcher", + "type": "Function", "tags": [], - "label": "uiSettings", + "label": "registerSwitcher", "description": [ - "{@link UiSettingsServiceStart}" + "\nRegister a {@link CapabilitiesSwitcher} to be used to change the default state\nof the {@link Capabilities} entries when resolving them.\n\nA capabilities switcher can only change the state of existing capabilities.\nCapabilities added or removed when invoking the switcher will be ignored.\n" ], "signature": [ + "(switcher: ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.UiSettingsServiceStart", - "text": "UiSettingsServiceStart" + "section": "def-server.CapabilitiesSwitcher", + "text": "CapabilitiesSwitcher" + }, + ") => void" + ], + "path": "src/core/server/capabilities/capabilities_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.CapabilitiesSetup.registerSwitcher.$1", + "type": "Function", + "tags": [], + "label": "switcher", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CapabilitiesSwitcher", + "text": "CapabilitiesSwitcher" + } + ], + "path": "src/core/server/capabilities/capabilities_service.ts", + "deprecated": false, + "isRequired": true } ], - "path": "src/core/server/index.ts", - "deprecated": false + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.CoreStatus", + "id": "def-server.CapabilitiesStart", "type": "Interface", "tags": [], - "label": "CoreStatus", + "label": "CapabilitiesStart", "description": [ - "\nStatus of core services.\n" + "\nAPIs to access the application {@link Capabilities}.\n" ], - "path": "src/core/server/status/types.ts", + "path": "src/core/server/capabilities/capabilities_service.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.CoreStatus.elasticsearch", - "type": "Object", + "id": "def-server.CapabilitiesStart.resolveCapabilities", + "type": "Function", "tags": [], - "label": "elasticsearch", - "description": [], + "label": "resolveCapabilities", + "description": [ + "\nResolve the {@link Capabilities} to be used for given request" + ], "signature": [ + "(request: ", + "KibanaRequest", + ", options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.ServiceStatus", - "text": "ServiceStatus" + "section": "def-server.ResolveCapabilitiesOptions", + "text": "ResolveCapabilitiesOptions" }, - "" + " | undefined) => Promise<", + "Capabilities", + ">" ], - "path": "src/core/server/status/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.CoreStatus.savedObjects", - "type": "Object", - "tags": [], - "label": "savedObjects", - "description": [], - "signature": [ + "path": "src/core/server/capabilities/capabilities_service.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ServiceStatus", - "text": "ServiceStatus" + "parentPluginId": "core", + "id": "def-server.CapabilitiesStart.resolveCapabilities.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "src/core/server/capabilities/capabilities_service.ts", + "deprecated": false, + "isRequired": true }, - "" + { + "parentPluginId": "core", + "id": "def-server.CapabilitiesStart.resolveCapabilities.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ResolveCapabilitiesOptions", + "text": "ResolveCapabilitiesOptions" + }, + " | undefined" + ], + "path": "src/core/server/capabilities/capabilities_service.ts", + "deprecated": false, + "isRequired": false + } ], - "path": "src/core/server/status/types.ts", - "deprecated": false + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.DeprecationsClient", + "id": "def-server.ConfigDeprecationContext", "type": "Interface", "tags": [], - "label": "DeprecationsClient", + "label": "ConfigDeprecationContext", "description": [ - "\nServer-side client that provides access to fetch all Kibana deprecations\n" + "\nDeprecation context provided to {@link ConfigDeprecation | config deprecations}\n" ], - "path": "src/core/server/deprecations/deprecations_service.ts", + "path": "node_modules/@types/kbn__config/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.DeprecationsClient.getAllDeprecations", - "type": "Function", + "id": "def-server.ConfigDeprecationContext.version", + "type": "string", "tags": [], - "label": "getAllDeprecations", - "description": [], - "signature": [ - "() => Promise<", - "DomainDeprecationDetails", - "[]>" + "label": "version", + "description": [ + "The current Kibana version, e.g `7.16.1`, `8.0.0`" ], - "path": "src/core/server/deprecations/deprecations_service.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.DeprecationSettings", - "type": "Interface", - "tags": [], - "label": "DeprecationSettings", - "description": [ - "\nUiSettings deprecation field options." - ], - "path": "src/core/types/ui_settings.ts", - "deprecated": false, - "children": [ + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false + }, { "parentPluginId": "core", - "id": "def-server.DeprecationSettings.message", + "id": "def-server.ConfigDeprecationContext.branch", "type": "string", "tags": [], - "label": "message", + "label": "branch", "description": [ - "Deprecation message" + "The current Kibana branch, e.g `7.x`, `7.16`, `master`" ], - "path": "src/core/types/ui_settings.ts", + "path": "node_modules/@types/kbn__config/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.DeprecationSettings.docLinksKey", - "type": "string", + "id": "def-server.ConfigDeprecationContext.docLinks", + "type": "Object", "tags": [], - "label": "docLinksKey", + "label": "docLinks", "description": [ - "Key to documentation links" + "Allow direct access to the doc links from the deprecation handler" ], - "path": "src/core/types/ui_settings.ts", + "signature": [ + "DocLinks" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", "deprecated": false } ], @@ -11293,33 +11952,52 @@ }, { "parentPluginId": "core", - "id": "def-server.DeprecationsRequestHandlerContext", + "id": "def-server.ConfigDeprecationDetails", "type": "Interface", "tags": [], - "label": "DeprecationsRequestHandlerContext", - "description": [ - "\nCore's `deprecations` request handler context." + "label": "ConfigDeprecationDetails", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ConfigDeprecationDetails", + "text": "ConfigDeprecationDetails" + }, + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.BaseDeprecationDetails", + "text": "BaseDeprecationDetails" + } ], - "path": "src/core/server/deprecations/deprecations_route_handler_context.ts", + "path": "src/core/server/deprecations/types.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.DeprecationsRequestHandlerContext.client", - "type": "Object", + "id": "def-server.ConfigDeprecationDetails.configPath", + "type": "string", "tags": [], - "label": "client", + "label": "configPath", + "description": [], + "path": "src/core/server/deprecations/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationDetails.deprecationType", + "type": "string", + "tags": [], + "label": "deprecationType", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.DeprecationsClient", - "text": "DeprecationsClient" - } + "\"config\"" ], - "path": "src/core/server/deprecations/deprecations_route_handler_context.ts", + "path": "src/core/server/deprecations/types.ts", "deprecated": false } ], @@ -11327,227 +12005,428 @@ }, { "parentPluginId": "core", - "id": "def-server.DeprecationsServiceSetup", + "id": "def-server.ConfigDeprecationFactory", "type": "Interface", "tags": [], - "label": "DeprecationsServiceSetup", + "label": "ConfigDeprecationFactory", "description": [ - "\nThe deprecations service provides a way for the Kibana platform to communicate deprecated\nfeatures and configs with its users. These deprecations are only communicated\nif the deployment is using these features. Allowing for a user tailored experience\nfor upgrading the stack version.\n\nThe Deprecation service is consumed by the upgrade assistant to assist with the upgrade\nexperience.\n\nIf a deprecated feature can be resolved without manual user intervention.\nUsing correctiveActions.api allows the Upgrade Assistant to use this api to correct the\ndeprecation upon a user trigger.\n" + "\nProvides helpers to generates the most commonly used {@link ConfigDeprecation}\nwhen invoking a {@link ConfigDeprecationProvider}.\n\nSee methods documentation for more detailed examples.\n" ], - "path": "src/core/server/deprecations/deprecations_service.ts", + "path": "node_modules/@types/kbn__config/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.DeprecationsServiceSetup.registerDeprecations", + "id": "def-server.ConfigDeprecationFactory.deprecate", "type": "Function", "tags": [], - "label": "registerDeprecations", - "description": [], + "label": "deprecate", + "description": [ + "\nDeprecate a configuration property from inside a plugin's configuration path.\nWill log a deprecation warning if the deprecatedKey was found.\n" + ], "signature": [ - "(deprecationContext: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.RegisterDeprecationsConfig", - "text": "RegisterDeprecationsConfig" - }, - ") => void" + "(deprecatedKey: string, removeBy: string, details: ", + "FactoryConfigDeprecationDetails", + ") => ", + "ConfigDeprecation" ], - "path": "src/core/server/deprecations/deprecations_service.ts", + "path": "node_modules/@types/kbn__config/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.DeprecationsServiceSetup.registerDeprecations.$1", - "type": "Object", + "id": "def-server.ConfigDeprecationFactory.deprecate.$1", + "type": "string", "tags": [], - "label": "deprecationContext", + "label": "deprecatedKey", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.RegisterDeprecationsConfig", - "text": "RegisterDeprecationsConfig" - } + "string" ], - "path": "src/core/server/deprecations/deprecations_service.ts", + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.deprecate.$2", + "type": "string", + "tags": [], + "label": "removeBy", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.deprecate.$3", + "type": "CompoundType", + "tags": [], + "label": "details", + "description": [], + "signature": [ + "FactoryConfigDeprecationDetails" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.DiscoveredPlugin", - "type": "Interface", - "tags": [], - "label": "DiscoveredPlugin", - "description": [ - "\nSmall container object used to expose information about discovered plugins that may\nor may not have been started." - ], - "path": "node_modules/@types/kbn__core-base-common/index.d.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-server.DiscoveredPlugin.id", - "type": "string", + "id": "def-server.ConfigDeprecationFactory.deprecateFromRoot", + "type": "Function", "tags": [], - "label": "id", + "label": "deprecateFromRoot", "description": [ - "\nIdentifier of the plugin." + "\nDeprecate a configuration property from the root configuration.\nWill log a deprecation warning if the deprecatedKey was found.\n\nThis should be only used when deprecating properties from different configuration's path.\nTo deprecate properties from inside a plugin's configuration, use 'deprecate' instead.\n" ], - "path": "node_modules/@types/kbn__core-base-common/index.d.ts", - "deprecated": false + "signature": [ + "(deprecatedKey: string, removeBy: string, details: ", + "FactoryConfigDeprecationDetails", + ") => ", + "ConfigDeprecation" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.deprecateFromRoot.$1", + "type": "string", + "tags": [], + "label": "deprecatedKey", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.deprecateFromRoot.$2", + "type": "string", + "tags": [], + "label": "removeBy", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.deprecateFromRoot.$3", + "type": "CompoundType", + "tags": [], + "label": "details", + "description": [], + "signature": [ + "FactoryConfigDeprecationDetails" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.DiscoveredPlugin.configPath", - "type": "CompoundType", + "id": "def-server.ConfigDeprecationFactory.rename", + "type": "Function", "tags": [], - "label": "configPath", + "label": "rename", "description": [ - "\nRoot configuration path used by the plugin, defaults to \"id\" in snake_case format." + "\nRename a configuration property from inside a plugin's configuration path.\nWill log a deprecation warning if the oldKey was found and deprecation applied.\n" ], "signature": [ - "string | string[]" - ], - "path": "node_modules/@types/kbn__core-base-common/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.DiscoveredPlugin.type", - "type": "Enum", - "tags": [], - "label": "type", - "description": [ - "\nType of the plugin, defaults to `standard`." + "(oldKey: string, newKey: string, details: ", + "FactoryConfigDeprecationDetails", + ") => ", + "ConfigDeprecation" ], - "signature": [ - "PluginType" + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.rename.$1", + "type": "string", + "tags": [], + "label": "oldKey", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.rename.$2", + "type": "string", + "tags": [], + "label": "newKey", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.rename.$3", + "type": "CompoundType", + "tags": [], + "label": "details", + "description": [], + "signature": [ + "FactoryConfigDeprecationDetails" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "node_modules/@types/kbn__core-base-common/index.d.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.DiscoveredPlugin.requiredPlugins", - "type": "Object", + "id": "def-server.ConfigDeprecationFactory.renameFromRoot", + "type": "Function", "tags": [], - "label": "requiredPlugins", + "label": "renameFromRoot", "description": [ - "\nAn optional list of the other plugins that **must be** installed and enabled\nfor this plugin to function properly." + "\nRename a configuration property from the root configuration.\nWill log a deprecation warning if the oldKey was found and deprecation applied.\n\nThis should be only used when renaming properties from different configuration's path.\nTo rename properties from inside a plugin's configuration, use 'rename' instead.\n" ], "signature": [ - "readonly string[]" - ], - "path": "node_modules/@types/kbn__core-base-common/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.DiscoveredPlugin.optionalPlugins", - "type": "Object", - "tags": [], - "label": "optionalPlugins", - "description": [ - "\nAn optional list of the other plugins that if installed and enabled **may be**\nleveraged by this plugin for some additional functionality but otherwise are\nnot required for this plugin to work properly." + "(oldKey: string, newKey: string, details: ", + "FactoryConfigDeprecationDetails", + ") => ", + "ConfigDeprecation" ], - "signature": [ - "readonly string[]" + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.renameFromRoot.$1", + "type": "string", + "tags": [], + "label": "oldKey", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.renameFromRoot.$2", + "type": "string", + "tags": [], + "label": "newKey", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.renameFromRoot.$3", + "type": "CompoundType", + "tags": [], + "label": "details", + "description": [], + "signature": [ + "FactoryConfigDeprecationDetails" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "node_modules/@types/kbn__core-base-common/index.d.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.DiscoveredPlugin.requiredBundles", - "type": "Object", + "id": "def-server.ConfigDeprecationFactory.unused", + "type": "Function", "tags": [], - "label": "requiredBundles", + "label": "unused", "description": [ - "\nList of plugin ids that this plugin's UI code imports modules from that are\nnot in `requiredPlugins`.\n" + "\nRemove a configuration property from inside a plugin's configuration path.\nWill log a deprecation warning if the unused key was found and deprecation applied.\n" ], "signature": [ - "readonly string[]" + "(unusedKey: string, details: ", + "FactoryConfigDeprecationDetails", + ") => ", + "ConfigDeprecation" ], - "path": "node_modules/@types/kbn__core-base-common/index.d.ts", - "deprecated": false + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.unused.$1", + "type": "string", + "tags": [], + "label": "unusedKey", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.unused.$2", + "type": "CompoundType", + "tags": [], + "label": "details", + "description": [], + "signature": [ + "FactoryConfigDeprecationDetails" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.DiscoveredPlugin.enabledOnAnonymousPages", - "type": "CompoundType", + "id": "def-server.ConfigDeprecationFactory.unusedFromRoot", + "type": "Function", "tags": [], - "label": "enabledOnAnonymousPages", + "label": "unusedFromRoot", "description": [ - "\nSpecifies whether this plugin - and its required dependencies - will be enabled for anonymous pages (login page, status page when\nconfigured, etc.) Default is false." + "\nRemove a configuration property from the root configuration.\nWill log a deprecation warning if the unused key was found and deprecation applied.\n\nThis should be only used when removing properties from outside of a plugin's configuration.\nTo remove properties from inside a plugin's configuration, use 'unused' instead.\n" ], "signature": [ - "boolean | undefined" + "(unusedKey: string, details: ", + "FactoryConfigDeprecationDetails", + ") => ", + "ConfigDeprecation" ], - "path": "node_modules/@types/kbn__core-base-common/index.d.ts", - "deprecated": false + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.unusedFromRoot.$1", + "type": "string", + "tags": [], + "label": "unusedKey", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.unusedFromRoot.$2", + "type": "CompoundType", + "tags": [], + "label": "details", + "description": [], + "signature": [ + "FactoryConfigDeprecationDetails" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.DocLinksServiceSetup", + "id": "def-server.ContextProviderOpts", "type": "Interface", "tags": [], - "label": "DocLinksServiceSetup", - "description": [], - "path": "node_modules/@types/kbn__core-doc-links-server/index.d.ts", + "label": "ContextProviderOpts", + "description": [ + "\nDefinition of a context provider" + ], + "signature": [ + "ContextProviderOpts", + "" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.DocLinksServiceSetup.version", + "id": "def-server.ContextProviderOpts.name", "type": "string", "tags": [], - "label": "version", + "label": "name", "description": [ - "The branch/version the docLinks are pointing to" + "\nThe name of the provider." ], - "path": "node_modules/@types/kbn__core-doc-links-server/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.DocLinksServiceSetup.elasticWebsiteUrl", - "type": "string", + "id": "def-server.ContextProviderOpts.context$", + "type": "Object", "tags": [], - "label": "elasticWebsiteUrl", + "label": "context$", "description": [ - "The base url for the elastic website" + "\nObservable that emits the custom context." ], - "path": "node_modules/@types/kbn__core-doc-links-server/index.d.ts", + "signature": [ + "Observable", + "" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.DocLinksServiceSetup.links", + "id": "def-server.ContextProviderOpts.schema", "type": "Object", "tags": [], - "label": "links", + "label": "schema", "description": [ - "A record of all registered doc links" + "\nSchema declaring and documenting the expected output in the context$\n" ], "signature": [ - "DocLinks" + "{ [Key in keyof Required]: ", + "SchemaValue", + "; }" ], - "path": "node_modules/@types/kbn__core-doc-links-server/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false } ], @@ -11555,41 +12434,105 @@ }, { "parentPluginId": "core", - "id": "def-server.ElasticsearchConfigPreboot", + "id": "def-server.CorePreboot", "type": "Interface", "tags": [], - "label": "ElasticsearchConfigPreboot", + "label": "CorePreboot", "description": [ - "\nA limited set of Elasticsearch configuration entries exposed to the `preboot` plugins at `setup`.\n" + "\nContext passed to the `setup` method of `preboot` plugins." ], - "path": "src/core/server/elasticsearch/types.ts", + "path": "src/core/server/index.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.ElasticsearchConfigPreboot.hosts", - "type": "Array", + "id": "def-server.CorePreboot.analytics", + "type": "Object", "tags": [], - "label": "hosts", + "label": "analytics", "description": [ - "\nHosts that the client will connect to. If sniffing is enabled, this list will\nbe used as seeds to discover the rest of your cluster." + "{@link AnalyticsServicePreboot}" ], "signature": [ - "string[]" + "{ optIn: (optInConfig: ", + "OptInConfig", + ") => void; reportEvent: >(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ", + "Observable", + "<", + "TelemetryCounter", + ">; registerEventType: (eventTypeOps: ", + "EventTypeOpts", + ") => void; registerShipper: (Shipper: ", + "ShipperClassConstructor", + ", shipperConfig: ShipperConfig, opts?: ", + "RegisterShipperOpts", + " | undefined) => void; registerContextProvider: (contextProviderOpts: ", + "ContextProviderOpts", + ") => void; removeContextProvider: (contextProviderName: string) => void; }" ], - "path": "src/core/server/elasticsearch/types.ts", + "path": "src/core/server/index.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.ElasticsearchConfigPreboot.credentialsSpecified", - "type": "boolean", + "id": "def-server.CorePreboot.elasticsearch", + "type": "Object", "tags": [], - "label": "credentialsSpecified", + "label": "elasticsearch", "description": [ - "\nIndicates whether Elasticsearch configuration includes credentials (`username`, `password` or `serviceAccountToken`)." + "{@link ElasticsearchServicePreboot}" ], - "path": "src/core/server/elasticsearch/types.ts", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchServicePreboot", + "text": "ElasticsearchServicePreboot" + } + ], + "path": "src/core/server/index.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CorePreboot.http", + "type": "Object", + "tags": [], + "label": "http", + "description": [ + "{@link HttpServicePreboot}" + ], + "signature": [ + "HttpServicePreboot", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.RequestHandlerContext", + "text": "RequestHandlerContext" + }, + ">" + ], + "path": "src/core/server/index.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CorePreboot.preboot", + "type": "Object", + "tags": [], + "label": "preboot", + "description": [ + "{@link PrebootServicePreboot}" + ], + "signature": [ + "PrebootServicePreboot" + ], + "path": "src/core/server/index.ts", "deprecated": false } ], @@ -11597,33 +12540,90 @@ }, { "parentPluginId": "core", - "id": "def-server.ElasticsearchRequestHandlerContext", + "id": "def-server.CoreRequestHandlerContext", "type": "Interface", "tags": [], - "label": "ElasticsearchRequestHandlerContext", + "label": "CoreRequestHandlerContext", "description": [ - "\nCore's `elasticsearch` request handler context." + "\nThe `core` context provided to route handler.\n\nProvides the following clients and services:\n - {@link SavedObjectsClient | savedObjects.client} - Saved Objects client\n which uses the credentials of the incoming request\n - {@link ISavedObjectTypeRegistry | savedObjects.typeRegistry} - Type registry containing\n all the registered types.\n - {@link IScopedClusterClient | elasticsearch.client} - Elasticsearch\n data client which uses the credentials of the incoming request\n - {@link IUiSettingsClient | uiSettings.client} - uiSettings client\n which uses the credentials of the incoming request" ], - "path": "src/core/server/elasticsearch/elasticsearch_route_handler_context.ts", + "path": "src/core/server/core_route_handler_context.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.ElasticsearchRequestHandlerContext.client", + "id": "def-server.CoreRequestHandlerContext.savedObjects", "type": "Object", "tags": [], - "label": "client", + "label": "savedObjects", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRequestHandlerContext", + "text": "SavedObjectsRequestHandlerContext" + } + ], + "path": "src/core/server/core_route_handler_context.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreRequestHandlerContext.elasticsearch", + "type": "Object", + "tags": [], + "label": "elasticsearch", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.IScopedClusterClient", - "text": "IScopedClusterClient" + "section": "def-server.ElasticsearchRequestHandlerContext", + "text": "ElasticsearchRequestHandlerContext" } ], - "path": "src/core/server/elasticsearch/elasticsearch_route_handler_context.ts", + "path": "src/core/server/core_route_handler_context.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreRequestHandlerContext.uiSettings", + "type": "Object", + "tags": [], + "label": "uiSettings", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.UiSettingsRequestHandlerContext", + "text": "UiSettingsRequestHandlerContext" + } + ], + "path": "src/core/server/core_route_handler_context.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreRequestHandlerContext.deprecations", + "type": "Object", + "tags": [], + "label": "deprecations", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.DeprecationsRequestHandlerContext", + "text": "DeprecationsRequestHandlerContext" + } + ], + "path": "src/core/server/core_route_handler_context.ts", "deprecated": false } ], @@ -11631,644 +12631,641 @@ }, { "parentPluginId": "core", - "id": "def-server.ElasticsearchServicePreboot", + "id": "def-server.CoreSetup", "type": "Interface", "tags": [], - "label": "ElasticsearchServicePreboot", - "description": [], - "path": "src/core/server/elasticsearch/types.ts", + "label": "CoreSetup", + "description": [ + "\nContext passed to the `setup` method of `standard` plugins.\n" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + "" + ], + "path": "src/core/server/index.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.ElasticsearchServicePreboot.config", + "id": "def-server.CoreSetup.analytics", "type": "Object", "tags": [], - "label": "config", + "label": "analytics", "description": [ - "\nA limited set of Elasticsearch configuration entries.\n" + "{@link AnalyticsServiceSetup}" ], "signature": [ - "{ readonly hosts: string[]; readonly credentialsSpecified: boolean; }" + "{ optIn: (optInConfig: ", + "OptInConfig", + ") => void; reportEvent: >(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ", + "Observable", + "<", + "TelemetryCounter", + ">; registerEventType: (eventTypeOps: ", + "EventTypeOpts", + ") => void; registerShipper: (Shipper: ", + "ShipperClassConstructor", + ", shipperConfig: ShipperConfig, opts?: ", + "RegisterShipperOpts", + " | undefined) => void; registerContextProvider: (contextProviderOpts: ", + "ContextProviderOpts", + ") => void; removeContextProvider: (contextProviderName: string) => void; }" ], - "path": "src/core/server/elasticsearch/types.ts", + "path": "src/core/server/index.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.ElasticsearchServicePreboot.createClient", - "type": "Function", + "id": "def-server.CoreSetup.capabilities", + "type": "Object", "tags": [], - "label": "createClient", + "label": "capabilities", "description": [ - "\nCreate application specific Elasticsearch cluster API client with customized config. See {@link IClusterClient}.\n" + "{@link CapabilitiesSetup}" ], "signature": [ - "(type: string, clientConfig?: Partial<", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchClientConfig", - "text": "ElasticsearchClientConfig" - }, - "> | undefined) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ICustomClusterClient", - "text": "ICustomClusterClient" + "section": "def-server.CapabilitiesSetup", + "text": "CapabilitiesSetup" } ], - "path": "src/core/server/elasticsearch/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "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, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.ElasticsearchServicePreboot.createClient.$2", - "type": "Object", - "tags": [], - "label": "clientConfig", - "description": [ - "A config consists of Elasticsearch JS client options and\nvalid sub-set of Elasticsearch service config.\nWe fill all the missing properties in the `clientConfig` using the default\nElasticsearch config so that we don't depend on default values set and\ncontrolled by underlying Elasticsearch JS client.\nWe don't run validation against the passed config and expect it to be valid." - ], - "signature": [ - "Partial<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchClientConfig", - "text": "ElasticsearchClientConfig" - }, - "> | undefined" - ], - "path": "src/core/server/elasticsearch/types.ts", - "deprecated": false, - "isRequired": false - } + "path": "src/core/server/index.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreSetup.docLinks", + "type": "Object", + "tags": [], + "label": "docLinks", + "description": [ + "{@link DocLinksServiceSetup}" ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.ElasticsearchServiceSetup", - "type": "Interface", - "tags": [], - "label": "ElasticsearchServiceSetup", - "description": [], - "path": "src/core/server/elasticsearch/types.ts", - "deprecated": false, - "children": [ + "signature": [ + "DocLinksServiceSetup" + ], + "path": "src/core/server/index.ts", + "deprecated": false + }, { "parentPluginId": "core", - "id": "def-server.ElasticsearchServiceSetup.setUnauthorizedErrorHandler", - "type": "Function", + "id": "def-server.CoreSetup.elasticsearch", + "type": "Object", "tags": [], - "label": "setUnauthorizedErrorHandler", + "label": "elasticsearch", "description": [ - "\nRegister a handler that will be called when unauthorized (401) errors are returned from any API\ncall to elasticsearch performed on behalf of a user via a {@link IScopedClusterClient | scoped cluster client}.\n" + "{@link ElasticsearchServiceSetup}" ], "signature": [ - "(handler: ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.UnauthorizedErrorHandler", - "text": "UnauthorizedErrorHandler" - }, - ") => void" - ], - "path": "src/core/server/elasticsearch/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.ElasticsearchServiceSetup.setUnauthorizedErrorHandler.$1", - "type": "Function", - "tags": [], - "label": "handler", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.UnauthorizedErrorHandler", - "text": "UnauthorizedErrorHandler" - } - ], - "path": "src/core/server/elasticsearch/types.ts", - "deprecated": false, - "isRequired": true + "section": "def-server.ElasticsearchServiceSetup", + "text": "ElasticsearchServiceSetup" } ], - "returnComment": [] + "path": "src/core/server/index.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.ElasticsearchServiceSetup.legacy", + "id": "def-server.CoreSetup.executionContext", "type": "Object", - "tags": [ - "deprecated" + "tags": [], + "label": "executionContext", + "description": [ + "{@link ExecutionContextSetup}" ], - "label": "legacy", - "description": [], "signature": [ - "{ readonly config$: ", - "Observable", + "ExecutionContextSetup" + ], + "path": "src/core/server/index.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreSetup.http", + "type": "CompoundType", + "tags": [], + "label": "http", + "description": [ + "{@link HttpServiceSetup}" + ], + "signature": [ + "HttpServiceSetup", "<", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchConfig", - "text": "ElasticsearchConfig" + "section": "def-server.RequestHandlerContext", + "text": "RequestHandlerContext" }, - ">; }" - ], - "path": "src/core/server/elasticsearch/types.ts", - "deprecated": true, - "references": [ + "> & { resources: ", { - "plugin": "console", - "path": "src/plugins/console/server/plugin.ts" - } - ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.ElasticsearchServiceStart", - "type": "Interface", - "tags": [], - "label": "ElasticsearchServiceStart", - "description": [], - "path": "src/core/server/elasticsearch/types.ts", - "deprecated": false, - "children": [ + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.HttpResources", + "text": "HttpResources" + }, + "; }" + ], + "path": "src/core/server/index.ts", + "deprecated": false + }, { "parentPluginId": "core", - "id": "def-server.ElasticsearchServiceStart.client", + "id": "def-server.CoreSetup.i18n", "type": "Object", "tags": [], - "label": "client", + "label": "i18n", "description": [ - "\nA pre-configured {@link IClusterClient | Elasticsearch client}\n" + "{@link I18nServiceSetup}" ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.IClusterClient", - "text": "IClusterClient" + "section": "def-server.I18nServiceSetup", + "text": "I18nServiceSetup" } ], - "path": "src/core/server/elasticsearch/types.ts", + "path": "src/core/server/index.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.ElasticsearchServiceStart.createClient", - "type": "Function", + "id": "def-server.CoreSetup.logging", + "type": "Object", "tags": [], - "label": "createClient", + "label": "logging", "description": [ - "\nCreate application specific Elasticsearch cluster API client with customized config. See {@link IClusterClient}.\n" + "{@link LoggingServiceSetup}" + ], + "signature": [ + "LoggingServiceSetup" + ], + "path": "src/core/server/index.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreSetup.metrics", + "type": "Object", + "tags": [], + "label": "metrics", + "description": [ + "{@link MetricsServiceSetup}" ], "signature": [ - "(type: string, clientConfig?: Partial<", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchClientConfig", - "text": "ElasticsearchClientConfig" - }, - "> | undefined) => ", + "section": "def-server.MetricsServiceSetup", + "text": "MetricsServiceSetup" + } + ], + "path": "src/core/server/index.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreSetup.savedObjects", + "type": "Object", + "tags": [], + "label": "savedObjects", + "description": [ + "{@link SavedObjectsServiceSetup}" + ], + "signature": [ { "pluginId": "core", "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ICustomClusterClient", - "text": "ICustomClusterClient" + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsServiceSetup", + "text": "SavedObjectsServiceSetup" } ], - "path": "src/core/server/elasticsearch/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "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, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.ElasticsearchServiceStart.createClient.$2", - "type": "Object", - "tags": [], - "label": "clientConfig", - "description": [ - "A config consists of Elasticsearch JS client options and\nvalid sub-set of Elasticsearch service config.\nWe fill all the missing properties in the `clientConfig` using the default\nElasticsearch config so that we don't depend on default values set and\ncontrolled by underlying Elasticsearch JS client.\nWe don't run validation against the passed config and expect it to be valid." - ], - "signature": [ - "Partial<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchClientConfig", - "text": "ElasticsearchClientConfig" - }, - "> | undefined" - ], - "path": "src/core/server/elasticsearch/types.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.ElasticsearchStatusMeta", - "type": "Interface", - "tags": [], - "label": "ElasticsearchStatusMeta", - "description": [], - "path": "src/core/server/elasticsearch/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.ElasticsearchStatusMeta.warningNodes", - "type": "Array", - "tags": [], - "label": "warningNodes", - "description": [], - "signature": [ - "NodeInfo[]" - ], - "path": "src/core/server/elasticsearch/types.ts", + "path": "src/core/server/index.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.ElasticsearchStatusMeta.incompatibleNodes", - "type": "Array", + "id": "def-server.CoreSetup.status", + "type": "Object", "tags": [], - "label": "incompatibleNodes", - "description": [], + "label": "status", + "description": [ + "{@link StatusServiceSetup}" + ], "signature": [ - "NodeInfo[]" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.StatusServiceSetup", + "text": "StatusServiceSetup" + } ], - "path": "src/core/server/elasticsearch/types.ts", + "path": "src/core/server/index.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.ElasticsearchStatusMeta.nodesInfoRequestError", + "id": "def-server.CoreSetup.uiSettings", "type": "Object", "tags": [], - "label": "nodesInfoRequestError", - "description": [], - "signature": [ - "Error | undefined" + "label": "uiSettings", + "description": [ + "{@link UiSettingsServiceSetup}" ], - "path": "src/core/server/elasticsearch/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.EnvironmentMode", - "type": "Interface", - "tags": [], - "label": "EnvironmentMode", - "description": [], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.EnvironmentMode.name", - "type": "CompoundType", - "tags": [], - "label": "name", - "description": [], "signature": [ - "\"production\" | \"development\"" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.UiSettingsServiceSetup", + "text": "UiSettingsServiceSetup" + } ], - "path": "node_modules/@types/kbn__config/index.d.ts", + "path": "src/core/server/index.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.EnvironmentMode.dev", - "type": "boolean", + "id": "def-server.CoreSetup.deprecations", + "type": "Object", "tags": [], - "label": "dev", - "description": [], - "path": "node_modules/@types/kbn__config/index.d.ts", + "label": "deprecations", + "description": [ + "{@link DeprecationsServiceSetup}" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.DeprecationsServiceSetup", + "text": "DeprecationsServiceSetup" + } + ], + "path": "src/core/server/index.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.EnvironmentMode.prod", - "type": "boolean", + "id": "def-server.CoreSetup.getStartServices", + "type": "Function", "tags": [], - "label": "prod", - "description": [], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false + "label": "getStartServices", + "description": [ + "{@link StartServicesAccessor}" + ], + "signature": [ + "() => Promise<[", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + }, + ", TPluginsStart, TStart]>" + ], + "path": "src/core/server/index.ts", + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.Event", + "id": "def-server.CoreStart", "type": "Interface", "tags": [], - "label": "Event", + "label": "CoreStart", "description": [ - "\nDefinition of the full event structure" + "\nContext passed to the plugins `start` method.\n" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "src/core/server/index.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.Event.timestamp", - "type": "string", + "id": "def-server.CoreStart.analytics", + "type": "Object", "tags": [], - "label": "timestamp", + "label": "analytics", "description": [ - "\nThe time the event was generated in ISO format." + "{@link AnalyticsServiceStart}" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "signature": [ + "{ optIn: (optInConfig: ", + "OptInConfig", + ") => void; reportEvent: >(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ", + "Observable", + "<", + "TelemetryCounter", + ">; }" + ], + "path": "src/core/server/index.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.Event.event_type", - "type": "string", + "id": "def-server.CoreStart.capabilities", + "type": "Object", "tags": [], - "label": "event_type", + "label": "capabilities", "description": [ - "\nThe event type." + "{@link CapabilitiesStart}" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CapabilitiesStart", + "text": "CapabilitiesStart" + } + ], + "path": "src/core/server/index.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.Event.properties", + "id": "def-server.CoreStart.docLinks", "type": "Object", "tags": [], - "label": "properties", + "label": "docLinks", "description": [ - "\nThe specific properties of the event type." + "{@link DocLinksServiceStart}" ], "signature": [ - "{ [x: string]: unknown; }" + "DocLinksServiceSetup" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "src/core/server/index.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.Event.context", + "id": "def-server.CoreStart.elasticsearch", "type": "Object", "tags": [], - "label": "context", + "label": "elasticsearch", "description": [ - "\nThe {@link EventContext} enriched during the processing pipeline." + "{@link ElasticsearchServiceStart}" ], "signature": [ - "EventContext" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchServiceStart", + "text": "ElasticsearchServiceStart" + } ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "src/core/server/index.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.EventContext", - "type": "Interface", - "tags": [], - "label": "EventContext", - "description": [ - "\nDefinition of the context that can be appended to the events through the {@link IAnalyticsClient.registerContextProvider}." - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-server.EventContext.cluster_uuid", - "type": "string", + "id": "def-server.CoreStart.executionContext", + "type": "Object", "tags": [], - "label": "cluster_uuid", + "label": "executionContext", "description": [ - "\nThe UUID of the cluster" + "{@link ExecutionContextStart}" ], "signature": [ - "string | undefined" + "ExecutionContextSetup" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "src/core/server/index.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.EventContext.cluster_name", - "type": "string", + "id": "def-server.CoreStart.http", + "type": "Object", "tags": [], - "label": "cluster_name", + "label": "http", "description": [ - "\nThe name of the cluster." + "{@link HttpServiceStart}" ], "signature": [ - "string | undefined" + "HttpServiceStart" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "src/core/server/index.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.EventContext.license_id", - "type": "string", + "id": "def-server.CoreStart.metrics", + "type": "Object", "tags": [], - "label": "license_id", + "label": "metrics", "description": [ - "\nThe license ID." + "{@link MetricsServiceStart}" ], "signature": [ - "string | undefined" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.MetricsServiceSetup", + "text": "MetricsServiceSetup" + } ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "src/core/server/index.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.EventContext.userId", - "type": "string", + "id": "def-server.CoreStart.savedObjects", + "type": "Object", "tags": [], - "label": "userId", + "label": "savedObjects", "description": [ - "\nThe unique user ID." + "{@link SavedObjectsServiceStart}" ], "signature": [ - "string | undefined" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsServiceStart", + "text": "SavedObjectsServiceStart" + } ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "src/core/server/index.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.EventContext.cloudId", - "type": "string", + "id": "def-server.CoreStart.uiSettings", + "type": "Object", "tags": [], - "label": "cloudId", + "label": "uiSettings", "description": [ - "\nThe Cloud ID." + "{@link UiSettingsServiceStart}" ], "signature": [ - "string | undefined" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.UiSettingsServiceStart", + "text": "UiSettingsServiceStart" + } ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "src/core/server/index.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreStatus", + "type": "Interface", + "tags": [], + "label": "CoreStatus", + "description": [ + "\nStatus of core services.\n" + ], + "path": "src/core/server/status/types.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.EventContext.isElasticCloudUser", - "type": "CompoundType", + "id": "def-server.CoreStatus.elasticsearch", + "type": "Object", "tags": [], - "label": "isElasticCloudUser", - "description": [ - "\n`true` if the user is logged in via the Elastic Cloud authentication provider." - ], + "label": "elasticsearch", + "description": [], "signature": [ - "boolean | undefined" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ServiceStatus", + "text": "ServiceStatus" + }, + "" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "src/core/server/status/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.EventContext.version", - "type": "string", + "id": "def-server.CoreStatus.savedObjects", + "type": "Object", "tags": [], - "label": "version", - "description": [ - "\nThe product's version." - ], + "label": "savedObjects", + "description": [], "signature": [ - "string | undefined" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ServiceStatus", + "text": "ServiceStatus" + }, + "" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "src/core/server/status/types.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.CustomHttpResponseOptions", + "type": "Interface", + "tags": [], + "label": "CustomHttpResponseOptions", + "description": [ + "\nHTTP response parameters for a response with adjustable status code." + ], + "signature": [ + "CustomHttpResponseOptions", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.EventContext.pageName", - "type": "string", + "id": "def-server.CustomHttpResponseOptions.body", + "type": "Uncategorized", "tags": [], - "label": "pageName", + "label": "body", "description": [ - "\nThe name of the current page." + "HTTP message to send to the client" ], "signature": [ - "string | undefined" + "T | undefined" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.EventContext.applicationId", - "type": "string", + "id": "def-server.CustomHttpResponseOptions.headers", + "type": "CompoundType", "tags": [], - "label": "applicationId", + "label": "headers", "description": [ - "\nThe current application ID." + "HTTP Headers with additional information about response" ], "signature": [ - "string | undefined" + "ResponseHeaders", + " | undefined" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.EventContext.entityId", - "type": "string", + "id": "def-server.CustomHttpResponseOptions.bypassErrorFormat", + "type": "CompoundType", "tags": [], - "label": "entityId", + "label": "bypassErrorFormat", "description": [ - "\nThe current entity ID (dashboard ID, visualization ID, etc.)." + "Bypass the default error formatting" ], "signature": [ - "string | undefined" + "boolean | undefined" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.EventContext.Unnamed", - "type": "IndexSignature", + "id": "def-server.CustomHttpResponseOptions.statusCode", + "type": "number", "tags": [], - "label": "[key: string]: unknown", - "description": [ - "\nAdditional keys are allowed." - ], - "signature": [ - "[key: string]: unknown" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "label": "statusCode", + "description": [], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false } ], @@ -12276,155 +13273,104 @@ }, { "parentPluginId": "core", - "id": "def-server.EventTypeOpts", + "id": "def-server.DeprecationsClient", "type": "Interface", "tags": [], - "label": "EventTypeOpts", + "label": "DeprecationsClient", "description": [ - "\nDefinition of an Event Type." - ], - "signature": [ - "EventTypeOpts", - "" + "\nServer-side client that provides access to fetch all Kibana deprecations\n" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "src/core/server/deprecations/deprecations_service.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.EventTypeOpts.eventType", - "type": "string", - "tags": [], - "label": "eventType", - "description": [ - "\nThe event type's unique name." - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.EventTypeOpts.schema", - "type": "Object", + "id": "def-server.DeprecationsClient.getAllDeprecations", + "type": "Function", "tags": [], - "label": "schema", - "description": [ - "\nSchema declaring and documenting the expected structure of this event type.\n" - ], + "label": "getAllDeprecations", + "description": [], "signature": [ - "{ [Key in keyof Required]: ", - "SchemaValue", - "; }" + "() => Promise<", + "DomainDeprecationDetails", + "[]>" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false + "path": "src/core/server/deprecations/deprecations_service.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.ExecutionContextSetup", + "id": "def-server.DeprecationSettings", "type": "Interface", "tags": [], - "label": "ExecutionContextSetup", - "description": [], - "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", + "label": "DeprecationSettings", + "description": [ + "\nUiSettings deprecation field options." + ], + "path": "src/core/types/ui_settings.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.ExecutionContextSetup.withContext", - "type": "Function", + "id": "def-server.DeprecationSettings.message", + "type": "string", "tags": [], - "label": "withContext", + "label": "message", "description": [ - "\nKeeps track of execution context while the passed function is executed.\nData are carried over all async operations spawned by the passed function.\nThe nested calls stack the registered context on top of each other." - ], - "signature": [ - "(context: ", - "KibanaExecutionContext", - " | undefined, fn: (...args: any[]) => R) => R" - ], - "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.ExecutionContextSetup.withContext.$1", - "type": "Object", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "KibanaExecutionContext", - " | undefined" - ], - "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", - "deprecated": false, - "isRequired": false - }, - { - "parentPluginId": "core", - "id": "def-server.ExecutionContextSetup.withContext.$2", - "type": "Function", - "tags": [], - "label": "fn", - "description": [], - "signature": [ - "(...args: any[]) => R" - ], - "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", - "deprecated": false, - "isRequired": true - } + "Deprecation message" ], - "returnComment": [] + "path": "src/core/types/ui_settings.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.ExecutionContextSetup.getAsLabels", - "type": "Function", + "id": "def-server.DeprecationSettings.docLinksKey", + "type": "string", "tags": [], - "label": "getAsLabels", - "description": [], - "signature": [ - "() => ", - "Labels" + "label": "docLinksKey", + "description": [ + "Key to documentation links" ], - "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "src/core/types/ui_settings.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.FakeRequest", + "id": "def-server.DeprecationsRequestHandlerContext", "type": "Interface", "tags": [], - "label": "FakeRequest", + "label": "DeprecationsRequestHandlerContext", "description": [ - "\nFake request object created manually by Kibana plugins." + "\nCore's `deprecations` request handler context." ], - "path": "src/core/server/elasticsearch/types.ts", + "path": "src/core/server/deprecations/deprecations_route_handler_context.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.FakeRequest.headers", - "type": "CompoundType", + "id": "def-server.DeprecationsRequestHandlerContext.client", + "type": "Object", "tags": [], - "label": "headers", - "description": [ - "Headers used for authentication against Elasticsearch" - ], + "label": "client", + "description": [], "signature": [ - "{ warning?: string | string[] | undefined; from?: string | string[] | undefined; date?: string | string[] | undefined; expires?: string | string[] | undefined; range?: string | string[] | undefined; origin?: string | string[] | undefined; location?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; etag?: string | string[] | undefined; expect?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.DeprecationsClient", + "text": "DeprecationsClient" + } ], - "path": "src/core/server/elasticsearch/types.ts", + "path": "src/core/server/deprecations/deprecations_route_handler_context.ts", "deprecated": false } ], @@ -12432,555 +13378,746 @@ }, { "parentPluginId": "core", - "id": "def-server.FeatureDeprecationDetails", + "id": "def-server.DeprecationsServiceSetup", "type": "Interface", "tags": [], - "label": "FeatureDeprecationDetails", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.FeatureDeprecationDetails", - "text": "FeatureDeprecationDetails" - }, - " extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.BaseDeprecationDetails", - "text": "BaseDeprecationDetails" - } + "label": "DeprecationsServiceSetup", + "description": [ + "\nThe deprecations service provides a way for the Kibana platform to communicate deprecated\nfeatures and configs with its users. These deprecations are only communicated\nif the deployment is using these features. Allowing for a user tailored experience\nfor upgrading the stack version.\n\nThe Deprecation service is consumed by the upgrade assistant to assist with the upgrade\nexperience.\n\nIf a deprecated feature can be resolved without manual user intervention.\nUsing correctiveActions.api allows the Upgrade Assistant to use this api to correct the\ndeprecation upon a user trigger.\n" ], - "path": "src/core/server/deprecations/types.ts", + "path": "src/core/server/deprecations/deprecations_service.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.FeatureDeprecationDetails.deprecationType", - "type": "string", + "id": "def-server.DeprecationsServiceSetup.registerDeprecations", + "type": "Function", "tags": [], - "label": "deprecationType", + "label": "registerDeprecations", "description": [], "signature": [ - "\"feature\" | undefined" + "(deprecationContext: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.RegisterDeprecationsConfig", + "text": "RegisterDeprecationsConfig" + }, + ") => void" ], - "path": "src/core/server/deprecations/types.ts", - "deprecated": false + "path": "src/core/server/deprecations/deprecations_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.DeprecationsServiceSetup.registerDeprecations.$1", + "type": "Object", + "tags": [], + "label": "deprecationContext", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.RegisterDeprecationsConfig", + "text": "RegisterDeprecationsConfig" + } + ], + "path": "src/core/server/deprecations/deprecations_service.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.GetDeprecationsContext", + "id": "def-server.DiscoveredPlugin", "type": "Interface", "tags": [], - "label": "GetDeprecationsContext", - "description": [], - "path": "src/core/server/deprecations/types.ts", + "label": "DiscoveredPlugin", + "description": [ + "\nSmall container object used to expose information about discovered plugins that may\nor may not have been started." + ], + "path": "node_modules/@types/kbn__core-base-common/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.GetDeprecationsContext.esClient", + "id": "def-server.DiscoveredPlugin.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "\nIdentifier of the plugin." + ], + "path": "node_modules/@types/kbn__core-base-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.DiscoveredPlugin.configPath", + "type": "CompoundType", + "tags": [], + "label": "configPath", + "description": [ + "\nRoot configuration path used by the plugin, defaults to \"id\" in snake_case format." + ], + "signature": [ + "string | string[]" + ], + "path": "node_modules/@types/kbn__core-base-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.DiscoveredPlugin.type", + "type": "Enum", + "tags": [], + "label": "type", + "description": [ + "\nType of the plugin, defaults to `standard`." + ], + "signature": [ + "PluginType" + ], + "path": "node_modules/@types/kbn__core-base-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.DiscoveredPlugin.requiredPlugins", "type": "Object", "tags": [], - "label": "esClient", - "description": [], + "label": "requiredPlugins", + "description": [ + "\nAn optional list of the other plugins that **must be** installed and enabled\nfor this plugin to function properly." + ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IScopedClusterClient", - "text": "IScopedClusterClient" - } + "readonly string[]" ], - "path": "src/core/server/deprecations/types.ts", + "path": "node_modules/@types/kbn__core-base-common/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.GetDeprecationsContext.savedObjectsClient", + "id": "def-server.DiscoveredPlugin.optionalPlugins", "type": "Object", "tags": [], - "label": "savedObjectsClient", - "description": [], + "label": "optionalPlugins", + "description": [ + "\nAn optional list of the other plugins that if installed and enabled **may be**\nleveraged by this plugin for some additional functionality but otherwise are\nnot required for this plugin to work properly." + ], + "signature": [ + "readonly string[]" + ], + "path": "node_modules/@types/kbn__core-base-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.DiscoveredPlugin.requiredBundles", + "type": "Object", + "tags": [], + "label": "requiredBundles", + "description": [ + "\nList of plugin ids that this plugin's UI code imports modules from that are\nnot in `requiredPlugins`.\n" + ], + "signature": [ + "readonly string[]" + ], + "path": "node_modules/@types/kbn__core-base-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.DiscoveredPlugin.enabledOnAnonymousPages", + "type": "CompoundType", + "tags": [], + "label": "enabledOnAnonymousPages", + "description": [ + "\nSpecifies whether this plugin - and its required dependencies - will be enabled for anonymous pages (login page, status page when\nconfigured, etc.) Default is false." + ], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__core-base-common/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.DocLinksServiceSetup", + "type": "Interface", + "tags": [], + "label": "DocLinksServiceSetup", + "description": [], + "path": "node_modules/@types/kbn__core-doc-links-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.DocLinksServiceSetup.version", + "type": "string", + "tags": [], + "label": "version", + "description": [ + "The branch/version the docLinks are pointing to" + ], + "path": "node_modules/@types/kbn__core-doc-links-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.DocLinksServiceSetup.elasticWebsiteUrl", + "type": "string", + "tags": [], + "label": "elasticWebsiteUrl", + "description": [ + "The base url for the elastic website" + ], + "path": "node_modules/@types/kbn__core-doc-links-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.DocLinksServiceSetup.links", + "type": "Object", + "tags": [], + "label": "links", + "description": [ + "A record of all registered doc links" + ], + "signature": [ + "DocLinks" + ], + "path": "node_modules/@types/kbn__core-doc-links-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchConfigPreboot", + "type": "Interface", + "tags": [], + "label": "ElasticsearchConfigPreboot", + "description": [ + "\nA limited set of Elasticsearch configuration entries exposed to the `preboot` plugins at `setup`.\n" + ], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchConfigPreboot.hosts", + "type": "Array", + "tags": [], + "label": "hosts", + "description": [ + "\nHosts that the client will connect to. If sniffing is enabled, this list will\nbe used as seeds to discover the rest of your cluster." + ], + "signature": [ + "string[]" + ], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchConfigPreboot.credentialsSpecified", + "type": "boolean", + "tags": [], + "label": "credentialsSpecified", + "description": [ + "\nIndicates whether Elasticsearch configuration includes credentials (`username`, `password` or `serviceAccountToken`)." + ], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchRequestHandlerContext", + "type": "Interface", + "tags": [], + "label": "ElasticsearchRequestHandlerContext", + "description": [ + "\nCore's `elasticsearch` request handler context." + ], + "path": "src/core/server/elasticsearch/elasticsearch_route_handler_context.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchRequestHandlerContext.client", + "type": "Object", + "tags": [], + "label": "client", + "description": [], "signature": [ - "{ 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?: ", + "docId": "kibCorePluginApi", + "section": "def-server.IScopedClusterClient", + "text": "IScopedClusterClient" + } + ], + "path": "src/core/server/elasticsearch/elasticsearch_route_handler_context.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchServicePreboot", + "type": "Interface", + "tags": [], + "label": "ElasticsearchServicePreboot", + "description": [], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchServicePreboot.config", + "type": "Object", + "tags": [], + "label": "config", + "description": [ + "\nA limited set of Elasticsearch configuration entries.\n" + ], + "signature": [ + "{ readonly hosts: string[]; readonly credentialsSpecified: boolean; }" + ], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchServicePreboot.createClient", + "type": "Function", + "tags": [], + "label": "createClient", + "description": [ + "\nCreate application specific Elasticsearch cluster API client with customized config. See {@link IClusterClient}.\n" + ], + "signature": [ + "(type: string, clientConfig?: Partial<", { "pluginId": "core", "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsObject", - "text": "SavedObjectsCheckConflictsObject" + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClientConfig", + "text": "ElasticsearchClientConfig" }, - "[], options?: ", + "> | undefined) => ", { "pluginId": "core", "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", + "docId": "kibCorePluginApi", + "section": "def-server.ICustomClusterClient", + "text": "ICustomClusterClient" + } + ], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsResponse", - "text": "SavedObjectsCheckConflictsResponse" + "parentPluginId": "core", + "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, + "isRequired": true }, - ">; delete: (type: string, id: string, options?: ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteOptions", - "text": "SavedObjectsDeleteOptions" - }, - ") => Promise<{}>; 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?: ", + "parentPluginId": "core", + "id": "def-server.ElasticsearchServicePreboot.createClient.$2", + "type": "Object", + "tags": [], + "label": "clientConfig", + "description": [ + "A config consists of Elasticsearch JS client options and\nvalid sub-set of Elasticsearch service config.\nWe fill all the missing properties in the `clientConfig` using the default\nElasticsearch config so that we don't depend on default values set and\ncontrolled by underlying Elasticsearch JS client.\nWe don't run validation against the passed config and expect it to be valid." + ], + "signature": [ + "Partial<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClientConfig", + "text": "ElasticsearchClientConfig" + }, + "> | undefined" + ], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchServiceSetup", + "type": "Interface", + "tags": [], + "label": "ElasticsearchServiceSetup", + "description": [], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchServiceSetup.setUnauthorizedErrorHandler", + "type": "Function", + "tags": [], + "label": "setUnauthorizedErrorHandler", + "description": [ + "\nRegister a handler that will be called when unauthorized (401) errors are returned from any API\ncall to elasticsearch performed on behalf of a user via a {@link IScopedClusterClient | scoped cluster client}.\n" + ], + "signature": [ + "(handler: ", { "pluginId": "core", "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" + "docId": "kibCorePluginApi", + "section": "def-server.UnauthorizedErrorHandler", + "text": "UnauthorizedErrorHandler" }, - ") => Promise<", + ") => void" + ], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResponse", - "text": "SavedObjectsBulkResponse" - }, - ">; bulkResolve: (objects: ", + "parentPluginId": "core", + "id": "def-server.ElasticsearchServiceSetup.setUnauthorizedErrorHandler.$1", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.UnauthorizedErrorHandler", + "text": "UnauthorizedErrorHandler" + } + ], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchServiceSetup.legacy", + "type": "Object", + "tags": [ + "deprecated" + ], + "label": "legacy", + "description": [], + "signature": [ + "{ readonly config$: ", + "Observable", + "<", { "pluginId": "core", "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResolveObject", - "text": "SavedObjectsBulkResolveObject" + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchConfig", + "text": "ElasticsearchConfig" }, - "[], options?: ", + ">; }" + ], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": true, + "references": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - " | undefined) => Promise<", + "plugin": "console", + "path": "src/plugins/console/server/plugin.ts" + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchServiceStart", + "type": "Interface", + "tags": [], + "label": "ElasticsearchServiceStart", + "description": [], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchServiceStart.client", + "type": "Object", + "tags": [], + "label": "client", + "description": [ + "\nA pre-configured {@link IClusterClient | Elasticsearch client}\n" + ], + "signature": [ { "pluginId": "core", "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResolveResponse", - "text": "SavedObjectsBulkResolveResponse" - }, - ">; get: (type: string, id: string, options?: ", + "docId": "kibCorePluginApi", + "section": "def-server.IClusterClient", + "text": "IClusterClient" + } + ], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchServiceStart.createClient", + "type": "Function", + "tags": [], + "label": "createClient", + "description": [ + "\nCreate application specific Elasticsearch cluster API client with customized config. See {@link IClusterClient}.\n" + ], + "signature": [ + "(type: string, clientConfig?: Partial<", { "pluginId": "core", "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClientConfig", + "text": "ElasticsearchClientConfig" }, - ") => Promise<", - "SavedObject", - ">; resolve: (type: string, id: string, options?: ", + "> | undefined) => ", { "pluginId": "core", "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", + "docId": "kibCorePluginApi", + "section": "def-server.ICustomClusterClient", + "text": "ICustomClusterClient" + } + ], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsResolveResponse", - "text": "SavedObjectsResolveResponse" + "parentPluginId": "core", + "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, + "isRequired": true }, - ">; 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: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreatePointInTimeFinderOptions", - "text": "SavedObjectsCreatePointInTimeFinderOptions" - }, - ", 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" - }, - "; }" + "parentPluginId": "core", + "id": "def-server.ElasticsearchServiceStart.createClient.$2", + "type": "Object", + "tags": [], + "label": "clientConfig", + "description": [ + "A config consists of Elasticsearch JS client options and\nvalid sub-set of Elasticsearch service config.\nWe fill all the missing properties in the `clientConfig` using the default\nElasticsearch config so that we don't depend on default values set and\ncontrolled by underlying Elasticsearch JS client.\nWe don't run validation against the passed config and expect it to be valid." + ], + "signature": [ + "Partial<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClientConfig", + "text": "ElasticsearchClientConfig" + }, + "> | undefined" + ], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false, + "isRequired": false + } ], - "path": "src/core/server/deprecations/types.ts", - "deprecated": false + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.HttpResources", + "id": "def-server.ElasticsearchStatusMeta", "type": "Interface", "tags": [], - "label": "HttpResources", - "description": [ - "\nHttpResources service is responsible for serving static & dynamic assets for Kibana application via HTTP.\nProvides API allowing plug-ins to respond with:\n- a pre-configured HTML page bootstrapping Kibana client app\n- custom HTML page\n- custom JS script file." - ], - "path": "src/core/server/http_resources/types.ts", + "label": "ElasticsearchStatusMeta", + "description": [], + "path": "src/core/server/elasticsearch/types.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.HttpResources.register", - "type": "Function", + "id": "def-server.ElasticsearchStatusMeta.warningNodes", + "type": "Array", "tags": [], - "label": "register", - "description": [ - "To register a route handler executing passed function to form response." + "label": "warningNodes", + "description": [], + "signature": [ + "NodeInfo[]" ], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchStatusMeta.incompatibleNodes", + "type": "Array", + "tags": [], + "label": "incompatibleNodes", + "description": [], "signature": [ - "(route: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfig", - "text": "RouteConfig" - }, - ", handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.HttpResourcesRequestHandler", - "text": "HttpResourcesRequestHandler" - }, - ") => void" + "NodeInfo[]" ], - "path": "src/core/server/http_resources/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpResources.register.$1", - "type": "Object", - "tags": [], - "label": "route", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfig", - "text": "RouteConfig" - }, - "" - ], - "path": "src/core/server/http_resources/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.HttpResources.register.$2", - "type": "Function", - "tags": [], - "label": "handler", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.HttpResourcesRequestHandler", - "text": "HttpResourcesRequestHandler" - }, - "" - ], - "path": "src/core/server/http_resources/types.ts", - "deprecated": false, - "isRequired": true - } + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchStatusMeta.nodesInfoRequestError", + "type": "Object", + "tags": [], + "label": "nodesInfoRequestError", + "description": [], + "signature": [ + "Error | undefined" ], - "returnComment": [] + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.HttpResourcesRenderOptions", + "id": "def-server.EnvironmentMode", "type": "Interface", "tags": [], - "label": "HttpResourcesRenderOptions", + "label": "EnvironmentMode", + "description": [], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.EnvironmentMode.name", + "type": "CompoundType", + "tags": [], + "label": "name", + "description": [], + "signature": [ + "\"production\" | \"development\"" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.EnvironmentMode.dev", + "type": "boolean", + "tags": [], + "label": "dev", + "description": [], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.EnvironmentMode.prod", + "type": "boolean", + "tags": [], + "label": "prod", + "description": [], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ErrorHttpResponseOptions", + "type": "Interface", + "tags": [], + "label": "ErrorHttpResponseOptions", "description": [ - "\nAllows to configure HTTP response parameters" + "\nHTTP response parameters" ], - "path": "src/core/server/http_resources/types.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.HttpResourcesRenderOptions.headers", + "id": "def-server.ErrorHttpResponseOptions.body", + "type": "CompoundType", + "tags": [], + "label": "body", + "description": [ + "HTTP message to send to the client" + ], + "signature": [ + "ResponseError", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.ErrorHttpResponseOptions.headers", "type": "CompoundType", "tags": [], "label": "headers", "description": [ - "\nHTTP Headers with additional information about response." + "HTTP Headers with additional information about response" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseHeaders", - "text": "ResponseHeaders" - }, + "ResponseHeaders", " | undefined" ], - "path": "src/core/server/http_resources/types.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false } ], @@ -12988,539 +14125,2354 @@ }, { "parentPluginId": "core", - "id": "def-server.HttpResourcesServiceToolkit", + "id": "def-server.Event", "type": "Interface", "tags": [], - "label": "HttpResourcesServiceToolkit", + "label": "Event", "description": [ - "\nExtended set of {@link KibanaResponseFactory} helpers used to respond with HTML or JS resource." + "\nDefinition of the full event structure" ], - "path": "src/core/server/http_resources/types.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.HttpResourcesServiceToolkit.renderCoreApp", - "type": "Function", + "id": "def-server.Event.timestamp", + "type": "string", "tags": [], - "label": "renderCoreApp", + "label": "timestamp", "description": [ - "To respond with HTML page bootstrapping Kibana application." - ], - "signature": [ - "(options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.HttpResourcesRenderOptions", - "text": "HttpResourcesRenderOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - ">" + "\nThe time the event was generated in ISO format." ], - "path": "src/core/server/http_resources/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpResourcesServiceToolkit.renderCoreApp.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.HttpResourcesRenderOptions", - "text": "HttpResourcesRenderOptions" - }, - " | undefined" - ], - "path": "src/core/server/http_resources/types.ts", - "deprecated": false, - "isRequired": false - } + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.Event.event_type", + "type": "string", + "tags": [], + "label": "event_type", + "description": [ + "\nThe event type." ], - "returnComment": [] + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.HttpResourcesServiceToolkit.renderAnonymousCoreApp", - "type": "Function", + "id": "def-server.Event.properties", + "type": "Object", "tags": [], - "label": "renderAnonymousCoreApp", + "label": "properties", "description": [ - "To respond with HTML page bootstrapping Kibana application without retrieving user-specific information." + "\nThe specific properties of the event type." ], "signature": [ - "(options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.HttpResourcesRenderOptions", - "text": "HttpResourcesRenderOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - ">" - ], - "path": "src/core/server/http_resources/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpResourcesServiceToolkit.renderAnonymousCoreApp.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.HttpResourcesRenderOptions", - "text": "HttpResourcesRenderOptions" - }, - " | undefined" - ], - "path": "src/core/server/http_resources/types.ts", - "deprecated": false, - "isRequired": false - } + "{ [x: string]: unknown; }" ], - "returnComment": [] + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.HttpResourcesServiceToolkit.renderHtml", - "type": "Function", + "id": "def-server.Event.context", + "type": "Object", "tags": [], - "label": "renderHtml", + "label": "context", "description": [ - "To respond with a custom HTML page." + "\nThe {@link EventContext} enriched during the processing pipeline." ], "signature": [ - "(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - "" - ], - "path": "src/core/server/http_resources/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpResourcesServiceToolkit.renderHtml.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - } - ], - "path": "src/core/server/http_resources/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.HttpResourcesServiceToolkit.renderJs", - "type": "Function", - "tags": [], - "label": "renderJs", - "description": [ - "To respond with a custom JS script file." - ], - "signature": [ - "(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - "" - ], - "path": "src/core/server/http_resources/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpResourcesServiceToolkit.renderJs.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - } - ], - "path": "src/core/server/http_resources/types.ts", - "deprecated": false, - "isRequired": true - } + "EventContext" ], - "returnComment": [] + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.I18nServiceSetup", + "id": "def-server.EventContext", "type": "Interface", "tags": [], - "label": "I18nServiceSetup", - "description": [], - "path": "src/core/server/i18n/i18n_service.ts", + "label": "EventContext", + "description": [ + "\nDefinition of the context that can be appended to the events through the {@link IAnalyticsClient.registerContextProvider}." + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.I18nServiceSetup.getLocale", - "type": "Function", + "id": "def-server.EventContext.cluster_uuid", + "type": "string", "tags": [], - "label": "getLocale", + "label": "cluster_uuid", "description": [ - "\nReturn the locale currently in use." + "\nThe UUID of the cluster" ], "signature": [ - "() => string" + "string | undefined" ], - "path": "src/core/server/i18n/i18n_service.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.I18nServiceSetup.getTranslationFiles", - "type": "Function", + "id": "def-server.EventContext.cluster_name", + "type": "string", "tags": [], - "label": "getTranslationFiles", + "label": "cluster_name", "description": [ - "\nReturn the absolute paths to translation files currently in use." + "\nThe name of the cluster." ], "signature": [ - "() => string[]" + "string | undefined" ], - "path": "src/core/server/i18n/i18n_service.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.EventContext.license_id", + "type": "string", + "tags": [], + "label": "license_id", + "description": [ + "\nThe license ID." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.EventContext.userId", + "type": "string", + "tags": [], + "label": "userId", + "description": [ + "\nThe unique user ID." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.EventContext.cloudId", + "type": "string", + "tags": [], + "label": "cloudId", + "description": [ + "\nThe Cloud ID." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.EventContext.isElasticCloudUser", + "type": "CompoundType", + "tags": [], + "label": "isElasticCloudUser", + "description": [ + "\n`true` if the user is logged in via the Elastic Cloud authentication provider." + ], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.EventContext.version", + "type": "string", + "tags": [], + "label": "version", + "description": [ + "\nThe product's version." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.EventContext.pageName", + "type": "string", + "tags": [], + "label": "pageName", + "description": [ + "\nThe name of the current page." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.EventContext.applicationId", + "type": "string", + "tags": [], + "label": "applicationId", + "description": [ + "\nThe current application ID." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.EventContext.entityId", + "type": "string", + "tags": [], + "label": "entityId", + "description": [ + "\nThe current entity ID (dashboard ID, visualization ID, etc.)." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.EventContext.Unnamed", + "type": "IndexSignature", + "tags": [], + "label": "[key: string]: unknown", + "description": [ + "\nAdditional keys are allowed." + ], + "signature": [ + "[key: string]: unknown" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.IClusterClient", + "id": "def-server.EventTypeOpts", "type": "Interface", "tags": [], - "label": "IClusterClient", + "label": "EventTypeOpts", "description": [ - "\nRepresents an Elasticsearch cluster API client created by the platform.\nIt allows to call API on behalf of the internal Kibana user and\nthe actual user that is derived from the request headers (via `asScoped(...)`).\n" + "\nDefinition of an Event Type." ], - "path": "src/core/server/elasticsearch/client/cluster_client.ts", + "signature": [ + "EventTypeOpts", + "" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.IClusterClient.asInternalUser", + "id": "def-server.EventTypeOpts.eventType", + "type": "string", + "tags": [], + "label": "eventType", + "description": [ + "\nThe event type's unique name." + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.EventTypeOpts.schema", "type": "Object", "tags": [], - "label": "asInternalUser", + "label": "schema", "description": [ - "\nA {@link ElasticsearchClient | client} to be used to query the ES cluster on behalf of the Kibana internal user" + "\nSchema declaring and documenting the expected structure of this event type.\n" ], "signature": [ - "{ eql: ", - "default", - "; search: { >(this: That, params?: ", - "SearchRequest", - " | ", - "SearchRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "SearchResponse", - ">; >(this: That, params?: ", - "SearchRequest", - " | ", - "SearchRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "SearchResponse", - ", unknown>>; >(this: That, params?: ", - "SearchRequest", - " | ", - "SearchRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "SearchResponse", - ">; }; create: { (this: That, params: ", - "CreateRequest", - " | ", - "CreateRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "WriteResponseBase", - ">; (this: That, params: ", - "CreateRequest", - " | ", - "CreateRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "WriteResponseBase", - ", unknown>>; (this: That, params: ", - "CreateRequest", - " | ", - "CreateRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "WriteResponseBase", - ">; }; monitoring: ", - "default", - "; security: ", - "default", - "; name: string | symbol; index: { (this: That, params: ", - "IndexRequest", - " | ", - "IndexRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "WriteResponseBase", - ">; (this: That, params: ", - "IndexRequest", - " | ", - "IndexRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "WriteResponseBase", - ", unknown>>; (this: That, params: ", - "IndexRequest", - " | ", - "IndexRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "WriteResponseBase", - ">; }; delete: { (this: That, params: ", - "DeleteRequest", - " | ", - "DeleteRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "WriteResponseBase", - ">; (this: That, params: ", - "DeleteRequest", - " | ", - "DeleteRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "WriteResponseBase", - ", unknown>>; (this: That, params: ", - "DeleteRequest", - " | ", - "DeleteRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "WriteResponseBase", - ">; }; get: { (this: That, params: ", - "GetRequest", - " | ", - "GetRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "GetResponse", - ">; (this: That, params: ", - "GetRequest", - " | ", - "GetRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "GetResponse", - ", unknown>>; (this: That, params: ", - "GetRequest", - " | ", - "GetRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "GetResponse", - ">; }; update: { (this: That, params: ", - "UpdateRequest", - " | ", - "UpdateRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "UpdateResponse", - ">; (this: That, params: ", - "UpdateRequest", - " | ", - "UpdateRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "UpdateResponse", - ", unknown>>; (this: That, params: ", - "UpdateRequest", - " | ", - "UpdateRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "UpdateResponse", - ">; }; closePointInTime: { (this: That, params: ", - "ClosePointInTimeRequest", - " | ", - "ClosePointInTimeRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "ClosePointInTimeResponse", - ">; (this: That, params: ", - "ClosePointInTimeRequest", - " | ", - "ClosePointInTimeRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "ClosePointInTimeResponse", - ", unknown>>; (this: That, params: ", - "ClosePointInTimeRequest", - " | ", - "ClosePointInTimeRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "ClosePointInTimeResponse", - ">; }; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", - "default", - "; helpers: ", - "default", - "; child: (opts: ", - "ClientOptions", - ") => ", - "default", - "; Internal: ", - "default", - "; asyncSearch: ", - "default", - "; autoscaling: ", - "default", - "; bulk: { (this: That, params: ", - "BulkRequest", - " | ", - "BulkRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "BulkResponse", - ">; (this: That, params: ", - "BulkRequest", - " | ", - "BulkRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "BulkResponse", - ", unknown>>; (this: That, params: ", - "BulkRequest", - " | ", - "BulkRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", + "{ [Key in keyof Required]: ", + "SchemaValue", + "; }" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ExecutionContextSetup", + "type": "Interface", + "tags": [], + "label": "ExecutionContextSetup", + "description": [], + "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ExecutionContextSetup.withContext", + "type": "Function", + "tags": [], + "label": "withContext", + "description": [ + "\nKeeps track of execution context while the passed function is executed.\nData are carried over all async operations spawned by the passed function.\nThe nested calls stack the registered context on top of each other." + ], + "signature": [ + "(context: ", + "KibanaExecutionContext", + " | undefined, fn: (...args: any[]) => R) => R" + ], + "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ExecutionContextSetup.withContext.$1", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "KibanaExecutionContext", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "core", + "id": "def-server.ExecutionContextSetup.withContext.$2", + "type": "Function", + "tags": [], + "label": "fn", + "description": [], + "signature": [ + "(...args: any[]) => R" + ], + "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.ExecutionContextSetup.getAsLabels", + "type": "Function", + "tags": [], + "label": "getAsLabels", + "description": [], + "signature": [ + "() => ", + "Labels" + ], + "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.FakeRequest", + "type": "Interface", + "tags": [], + "label": "FakeRequest", + "description": [ + "\nFake request object created manually by Kibana plugins." + ], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.FakeRequest.headers", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [ + "Headers used for authentication against Elasticsearch" + ], + "signature": [ + "{ warning?: string | string[] | undefined; from?: string | string[] | undefined; date?: string | string[] | undefined; expires?: string | string[] | undefined; range?: string | string[] | undefined; origin?: string | string[] | undefined; location?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; etag?: string | string[] | undefined; authorization?: string | string[] | undefined; connection?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" + ], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.FeatureDeprecationDetails", + "type": "Interface", + "tags": [], + "label": "FeatureDeprecationDetails", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.FeatureDeprecationDetails", + "text": "FeatureDeprecationDetails" + }, + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.BaseDeprecationDetails", + "text": "BaseDeprecationDetails" + } + ], + "path": "src/core/server/deprecations/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.FeatureDeprecationDetails.deprecationType", + "type": "string", + "tags": [], + "label": "deprecationType", + "description": [], + "signature": [ + "\"feature\" | undefined" + ], + "path": "src/core/server/deprecations/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.GetDeprecationsContext", + "type": "Interface", + "tags": [], + "label": "GetDeprecationsContext", + "description": [], + "path": "src/core/server/deprecations/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.GetDeprecationsContext.esClient", + "type": "Object", + "tags": [], + "label": "esClient", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IScopedClusterClient", + "text": "IScopedClusterClient" + } + ], + "path": "src/core/server/deprecations/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.GetDeprecationsContext.savedObjectsClient", + "type": "Object", + "tags": [], + "label": "savedObjectsClient", + "description": [], + "signature": [ + "{ 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" + }, + ">; delete: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + }, + ") => Promise<{}>; 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" + }, + ">; bulkResolve: (objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResolveObject", + "text": "SavedObjectsBulkResolveObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResolveResponse", + "text": "SavedObjectsBulkResolveResponse" + }, + ">; get: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + "SavedObject", + ">; 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: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreatePointInTimeFinderOptions", + "text": "SavedObjectsCreatePointInTimeFinderOptions" + }, + ", 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/deprecations/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpAuth", + "type": "Interface", + "tags": [], + "label": "HttpAuth", + "description": [], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpAuth.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [ + "\nGets authentication state for a request. Returned by `auth` interceptor.\n{@link GetAuthState}" + ], + "signature": [ + "(request: ", + "KibanaRequest", + ") => { status: ", + "AuthStatus", + "; state: T; }" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpAuth.get.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "core", + "id": "def-server.HttpAuth.isAuthenticated", + "type": "Function", + "tags": [], + "label": "isAuthenticated", + "description": [ + "\nReturns authentication status for a request.\n{@link IsAuthenticated}" + ], + "signature": [ + "(request: ", + "KibanaRequest", + ") => boolean" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpAuth.isAuthenticated.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResources", + "type": "Interface", + "tags": [], + "label": "HttpResources", + "description": [ + "\nHttpResources service is responsible for serving static & dynamic assets for Kibana application via HTTP.\nProvides API allowing plug-ins to respond with:\n- a pre-configured HTML page bootstrapping Kibana client app\n- custom HTML page\n- custom JS script file." + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpResources.register", + "type": "Function", + "tags": [], + "label": "register", + "description": [ + "To register a route handler executing passed function to form response." + ], + "signature": [ + "(route: ", + "RouteConfig", + ", handler: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.HttpResourcesRequestHandler", + "text": "HttpResourcesRequestHandler" + }, + ") => void" + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpResources.register.$1", + "type": "Object", + "tags": [], + "label": "route", + "description": [], + "signature": [ + "RouteConfig", + "" + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResources.register.$2", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.HttpResourcesRequestHandler", + "text": "HttpResourcesRequestHandler" + }, + "" + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesRenderOptions", + "type": "Interface", + "tags": [], + "label": "HttpResourcesRenderOptions", + "description": [ + "\nAllows to configure HTTP response parameters" + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesRenderOptions.headers", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [ + "\nHTTP Headers with additional information about response." + ], + "signature": [ + "ResponseHeaders", + " | undefined" + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesServiceToolkit", + "type": "Interface", + "tags": [], + "label": "HttpResourcesServiceToolkit", + "description": [ + "\nExtended set of {@link KibanaResponseFactory} helpers used to respond with HTML or JS resource." + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesServiceToolkit.renderCoreApp", + "type": "Function", + "tags": [], + "label": "renderCoreApp", + "description": [ + "To respond with HTML page bootstrapping Kibana application." + ], + "signature": [ + "(options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.HttpResourcesRenderOptions", + "text": "HttpResourcesRenderOptions" + }, + " | undefined) => Promise<", + "IKibanaResponse", + ">" + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesServiceToolkit.renderCoreApp.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.HttpResourcesRenderOptions", + "text": "HttpResourcesRenderOptions" + }, + " | undefined" + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesServiceToolkit.renderAnonymousCoreApp", + "type": "Function", + "tags": [], + "label": "renderAnonymousCoreApp", + "description": [ + "To respond with HTML page bootstrapping Kibana application without retrieving user-specific information." + ], + "signature": [ + "(options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.HttpResourcesRenderOptions", + "text": "HttpResourcesRenderOptions" + }, + " | undefined) => Promise<", + "IKibanaResponse", + ">" + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesServiceToolkit.renderAnonymousCoreApp.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.HttpResourcesRenderOptions", + "text": "HttpResourcesRenderOptions" + }, + " | undefined" + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesServiceToolkit.renderHtml", + "type": "Function", + "tags": [], + "label": "renderHtml", + "description": [ + "To respond with a custom HTML page." + ], + "signature": [ + "(options: ", + "HttpResponseOptions", + ") => ", + "IKibanaResponse", + "" + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesServiceToolkit.renderHtml.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "HttpResponseOptions" + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesServiceToolkit.renderJs", + "type": "Function", + "tags": [], + "label": "renderJs", + "description": [ + "To respond with a custom JS script file." + ], + "signature": [ + "(options: ", + "HttpResponseOptions", + ") => ", + "IKibanaResponse", + "" + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesServiceToolkit.renderJs.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "HttpResponseOptions" + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResponseOptions", + "type": "Interface", + "tags": [], + "label": "HttpResponseOptions", + "description": [ + "\nHTTP response parameters" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpResponseOptions.body", + "type": "CompoundType", + "tags": [], + "label": "body", + "description": [ + "HTTP message to send to the client" + ], + "signature": [ + "string | Record | ", + "Stream", + " | Buffer | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResponseOptions.headers", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [ + "HTTP Headers with additional information about response" + ], + "signature": [ + "ResponseHeaders", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResponseOptions.bypassErrorFormat", + "type": "CompoundType", + "tags": [], + "label": "bypassErrorFormat", + "description": [ + "Bypass the default error formatting" + ], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServerInfo", + "type": "Interface", + "tags": [], + "label": "HttpServerInfo", + "description": [ + "\nInformation about what hostname, port, and protocol the server process is\nrunning on. Note that this may not match the URL that end-users access\nKibana at. For the public URL, see {@link BasePath.publicBaseUrl}." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpServerInfo.name", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "The name of the Kibana server" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServerInfo.hostname", + "type": "string", + "tags": [], + "label": "hostname", + "description": [ + "The hostname of the server" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServerInfo.port", + "type": "number", + "tags": [], + "label": "port", + "description": [ + "The port the server is listening on" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServerInfo.protocol", + "type": "CompoundType", + "tags": [], + "label": "protocol", + "description": [ + "The protocol used by the server" + ], + "signature": [ + "\"http\" | \"https\" | \"socket\"" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServicePreboot", + "type": "Interface", + "tags": [], + "label": "HttpServicePreboot", + "description": [ + "\nKibana HTTP Service provides an abstraction to work with the HTTP stack at the `preboot` stage. This functionality\nallows Kibana to serve user requests even before Kibana becomes fully operational. Only Core and `preboot` plugins\ncan define HTTP routes at this stage.\n" + ], + "signature": [ + "HttpServicePreboot", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpServicePreboot.registerRoutes", + "type": "Function", + "tags": [], + "label": "registerRoutes", + "description": [ + "\nProvides ability to acquire `preboot` {@link IRouter} instance for a particular top-level path and register handler\nfunctions for any number of nested routes.\n" + ], + "signature": [ + "(path: string, callback: (router: ", + "IRouter", + ") => void) => void" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpServicePreboot.registerRoutes.$1", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServicePreboot.registerRoutes.$2", + "type": "Function", + "tags": [], + "label": "callback", + "description": [], + "signature": [ + "(router: ", + "IRouter", + ") => void" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServicePreboot.basePath", + "type": "Object", + "tags": [], + "label": "basePath", + "description": [ + "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." + ], + "signature": [ + "IBasePath" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServicePreboot.getServerInfo", + "type": "Function", + "tags": [], + "label": "getServerInfo", + "description": [ + "\nProvides common {@link HttpServerInfo | information} about the running preboot http server." + ], + "signature": [ + "() => ", + "HttpServerInfo" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup", + "type": "Interface", + "tags": [], + "label": "HttpServiceSetup", + "description": [ + "\nKibana HTTP Service provides own abstraction for work with HTTP stack.\nPlugins don't have direct access to `hapi` server and its primitives anymore. Moreover,\nplugins shouldn't rely on the fact that HTTP Service uses one or another library under the hood.\nThis gives the platform flexibility to upgrade or changing our internal HTTP stack without breaking plugins.\nIf the HTTP Service lacks functionality you need, we are happy to discuss and support your needs.\n" + ], + "signature": [ + "HttpServiceSetup", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.createCookieSessionStorageFactory", + "type": "Function", + "tags": [], + "label": "createCookieSessionStorageFactory", + "description": [ + "\nCreates cookie based session storage factory {@link SessionStorageFactory}" + ], + "signature": [ + "(cookieOptions: ", + "SessionStorageCookieOptions", + ") => Promise<", + "SessionStorageFactory", + ">" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.createCookieSessionStorageFactory.$1", + "type": "Object", + "tags": [], + "label": "cookieOptions", + "description": [ + "{@link SessionStorageCookieOptions } - options to configure created cookie session storage." + ], + "signature": [ + "SessionStorageCookieOptions", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.registerOnPreRouting", + "type": "Function", + "tags": [], + "label": "registerOnPreRouting", + "description": [ + "\nTo define custom logic to perform for incoming requests before server performs a route lookup.\n" + ], + "signature": [ + "(handler: ", + "OnPreRoutingHandler", + ") => void" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.registerOnPreRouting.$1", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link OnPreRoutingHandler } - function to call." + ], + "signature": [ + "OnPreRoutingHandler" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.registerOnPreAuth", + "type": "Function", + "tags": [], + "label": "registerOnPreAuth", + "description": [ + "\nTo define custom logic to perform for incoming requests before\nthe Auth interceptor performs a check that user has access to requested resources.\n" + ], + "signature": [ + "(handler: ", + "OnPreAuthHandler", + ") => void" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.registerOnPreAuth.$1", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link OnPreRoutingHandler } - function to call." + ], + "signature": [ + "OnPreAuthHandler" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.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: ", + "AuthenticationHandler", + ") => void" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.registerAuth.$1", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link AuthenticationHandler } - function to perform authentication." + ], + "signature": [ + "AuthenticationHandler" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "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: ", + "OnPostAuthHandler", + ") => void" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.registerOnPostAuth.$1", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link OnPostAuthHandler } - function to call." + ], + "signature": [ + "OnPostAuthHandler" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.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: ", + "OnPreResponseHandler", + ") => void" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.registerOnPreResponse.$1", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link OnPreResponseHandler } - function to call." + ], + "signature": [ + "OnPreResponseHandler" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.basePath", + "type": "Object", + "tags": [], + "label": "basePath", + "description": [ + "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." + ], + "signature": [ + "IBasePath" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.csp", + "type": "Object", + "tags": [], + "label": "csp", + "description": [ + "\nThe CSP config used for Kibana." + ], + "signature": [ + "ICspConfig" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.createRouter", + "type": "Function", + "tags": [], + "label": "createRouter", + "description": [ + "\nProvides ability to declare a handler function for a particular path and HTTP request method.\n" + ], + "signature": [ + "() => ", + "IRouter", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.registerRouteHandlerContext", + "type": "Function", + "tags": [], + "label": "registerRouteHandlerContext", + "description": [ + "\nRegister a context provider for a route handler." + ], + "signature": [ + ">(contextName: ContextName, provider: ", + "IContextProvider", + ") => ", + "IContextContainer" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.registerRouteHandlerContext.$1", + "type": "Uncategorized", + "tags": [], + "label": "contextName", + "description": [], + "signature": [ + "ContextName" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.registerRouteHandlerContext.$2", + "type": "Function", + "tags": [], + "label": "provider", + "description": [], + "signature": [ + "IContextProvider", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.getServerInfo", + "type": "Function", + "tags": [], + "label": "getServerInfo", + "description": [ + "\nProvides common {@link HttpServerInfo | information} about the running http server." + ], + "signature": [ + "() => ", + "HttpServerInfo" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceStart", + "type": "Interface", + "tags": [], + "label": "HttpServiceStart", + "description": [], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpServiceStart.basePath", + "type": "Object", + "tags": [], + "label": "basePath", + "description": [ + "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." + ], + "signature": [ + "IBasePath" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceStart.auth", + "type": "Object", + "tags": [], + "label": "auth", + "description": [ + "\nAuth status.\nSee {@link HttpAuth}" + ], + "signature": [ + "HttpAuth" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceStart.getServerInfo", + "type": "Function", + "tags": [], + "label": "getServerInfo", + "description": [ + "\nProvides common {@link HttpServerInfo | information} about the running http server." + ], + "signature": [ + "() => ", + "HttpServerInfo" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.I18nServiceSetup", + "type": "Interface", + "tags": [], + "label": "I18nServiceSetup", + "description": [], + "path": "src/core/server/i18n/i18n_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.I18nServiceSetup.getLocale", + "type": "Function", + "tags": [], + "label": "getLocale", + "description": [ + "\nReturn the locale currently in use." + ], + "signature": [ + "() => string" + ], + "path": "src/core/server/i18n/i18n_service.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.I18nServiceSetup.getTranslationFiles", + "type": "Function", + "tags": [], + "label": "getTranslationFiles", + "description": [ + "\nReturn the absolute paths to translation files currently in use." + ], + "signature": [ + "() => string[]" + ], + "path": "src/core/server/i18n/i18n_service.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.IBasePath", + "type": "Interface", + "tags": [], + "label": "IBasePath", + "description": [ + "\nAccess or manipulate the Kibana base path\n" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IBasePath.serverBasePath", + "type": "string", + "tags": [], + "label": "serverBasePath", + "description": [ + "\nreturns the server's basePath.\n\nSee {@link IBasePath.get} for getting the basePath value for a specific request" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IBasePath.publicBaseUrl", + "type": "string", + "tags": [], + "label": "publicBaseUrl", + "description": [ + "\nThe server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the\n{@link IBasePath.serverBasePath}.\n" + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IBasePath.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [ + "\nreturns `basePath` value, specific for an incoming request." + ], + "signature": [ + "(request: ", + "KibanaRequest", + ") => string" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IBasePath.get.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.IBasePath.set", + "type": "Function", + "tags": [], + "label": "set", + "description": [ + "\nsets `basePath` value, specific for an incoming request." + ], + "signature": [ + "(request: ", + "KibanaRequest", + ", requestSpecificBasePath: string) => void" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IBasePath.set.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.IBasePath.set.$2", + "type": "string", + "tags": [], + "label": "requestSpecificBasePath", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.IBasePath.prepend", + "type": "Function", + "tags": [], + "label": "prepend", + "description": [ + "\nPrepends `path` with the basePath." + ], + "signature": [ + "(path: string) => string" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IBasePath.prepend.$1", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.IBasePath.remove", + "type": "Function", + "tags": [], + "label": "remove", + "description": [ + "\nRemoves the prepended basePath from the `path`." + ], + "signature": [ + "(path: string) => string" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IBasePath.remove.$1", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.IClusterClient", + "type": "Interface", + "tags": [], + "label": "IClusterClient", + "description": [ + "\nRepresents an Elasticsearch cluster API client created by the platform.\nIt allows to call API on behalf of the internal Kibana user and\nthe actual user that is derived from the request headers (via `asScoped(...)`).\n" + ], + "path": "src/core/server/elasticsearch/client/cluster_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IClusterClient.asInternalUser", + "type": "Object", + "tags": [], + "label": "asInternalUser", + "description": [ + "\nA {@link ElasticsearchClient | client} to be used to query the ES cluster on behalf of the Kibana internal user" + ], + "signature": [ + "{ eql: ", + "default", + "; search: { >(this: That, params?: ", + "SearchRequest", + " | ", + "SearchRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "SearchResponse", + ">; >(this: That, params?: ", + "SearchRequest", + " | ", + "SearchRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "SearchResponse", + ", unknown>>; >(this: That, params?: ", + "SearchRequest", + " | ", + "SearchRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "SearchResponse", + ">; }; create: { (this: That, params: ", + "CreateRequest", + " | ", + "CreateRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "WriteResponseBase", + ">; (this: That, params: ", + "CreateRequest", + " | ", + "CreateRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "WriteResponseBase", + ", unknown>>; (this: That, params: ", + "CreateRequest", + " | ", + "CreateRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "WriteResponseBase", + ">; }; monitoring: ", + "default", + "; security: ", + "default", + "; name: string | symbol; index: { (this: That, params: ", + "IndexRequest", + " | ", + "IndexRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "WriteResponseBase", + ">; (this: That, params: ", + "IndexRequest", + " | ", + "IndexRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "WriteResponseBase", + ", unknown>>; (this: That, params: ", + "IndexRequest", + " | ", + "IndexRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "WriteResponseBase", + ">; }; delete: { (this: That, params: ", + "DeleteRequest", + " | ", + "DeleteRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "WriteResponseBase", + ">; (this: That, params: ", + "DeleteRequest", + " | ", + "DeleteRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "WriteResponseBase", + ", unknown>>; (this: That, params: ", + "DeleteRequest", + " | ", + "DeleteRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "WriteResponseBase", + ">; }; get: { (this: That, params: ", + "GetRequest", + " | ", + "GetRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "GetResponse", + ">; (this: That, params: ", + "GetRequest", + " | ", + "GetRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "GetResponse", + ", unknown>>; (this: That, params: ", + "GetRequest", + " | ", + "GetRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "GetResponse", + ">; }; update: { (this: That, params: ", + "UpdateRequest", + " | ", + "UpdateRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "UpdateResponse", + ">; (this: That, params: ", + "UpdateRequest", + " | ", + "UpdateRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "UpdateResponse", + ", unknown>>; (this: That, params: ", + "UpdateRequest", + " | ", + "UpdateRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "UpdateResponse", + ">; }; closePointInTime: { (this: That, params: ", + "ClosePointInTimeRequest", + " | ", + "ClosePointInTimeRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "ClosePointInTimeResponse", + ">; (this: That, params: ", + "ClosePointInTimeRequest", + " | ", + "ClosePointInTimeRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "ClosePointInTimeResponse", + ", unknown>>; (this: That, params: ", + "ClosePointInTimeRequest", + " | ", + "ClosePointInTimeRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "ClosePointInTimeResponse", + ">; }; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + "default", + "; helpers: ", + "default", + "; child: (opts: ", + "ClientOptions", + ") => ", + "default", + "; Internal: ", + "default", + "; asyncSearch: ", + "default", + "; autoscaling: ", + "default", + "; bulk: { (this: That, params: ", + "BulkRequest", + " | ", + "BulkRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "BulkResponse", + ">; (this: That, params: ", + "BulkRequest", + " | ", + "BulkRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "BulkResponse", + ", unknown>>; (this: That, params: ", + "BulkRequest", + " | ", + "BulkRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", "BulkResponse", ">; }; cat: ", "default", @@ -14449,1073 +17401,1570 @@ ">; }; updateByQueryRethrottle: { (this: That, params: ", "UpdateByQueryRethrottleRequest", " | ", - "UpdateByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "UpdateByQueryRethrottleResponse", - ">; (this: That, params: ", - "UpdateByQueryRethrottleRequest", + "UpdateByQueryRethrottleRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "UpdateByQueryRethrottleResponse", + ">; (this: That, params: ", + "UpdateByQueryRethrottleRequest", + " | ", + "UpdateByQueryRethrottleRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "UpdateByQueryRethrottleResponse", + ", unknown>>; (this: That, params: ", + "UpdateByQueryRethrottleRequest", + " | ", + "UpdateByQueryRethrottleRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "UpdateByQueryRethrottleResponse", + ">; }; watcher: ", + "default", + "; xpack: ", + "default", + "; }" + ], + "path": "src/core/server/elasticsearch/client/cluster_client.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IClusterClient.asScoped", + "type": "Function", + "tags": [], + "label": "asScoped", + "description": [ + "\nCreates a {@link IScopedClusterClient | scoped cluster client} bound to given {@link ScopeableRequest | request}" + ], + "signature": [ + "(request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ScopeableRequest", + "text": "ScopeableRequest" + }, + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IScopedClusterClient", + "text": "IScopedClusterClient" + } + ], + "path": "src/core/server/elasticsearch/client/cluster_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IClusterClient.asScoped.$1", + "type": "CompoundType", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ScopeableRequest", + "text": "ScopeableRequest" + } + ], + "path": "src/core/server/elasticsearch/client/cluster_client.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.IContextContainer", + "type": "Interface", + "tags": [], + "label": "IContextContainer", + "description": [ + "\nAn object that handles registration of context providers and configuring handlers with context.\n" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IContextContainer.registerContext", + "type": "Function", + "tags": [], + "label": "registerContext", + "description": [ + "\nRegister a new context provider.\n" + ], + "signature": [ + "(pluginOpaqueId: symbol, contextName: ContextName, provider: ", + "IContextProvider", + ") => this" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IContextContainer.registerContext.$1", + "type": "Uncategorized", + "tags": [], + "label": "pluginOpaqueId", + "description": [ + "- The plugin opaque ID for the plugin that registers this context." + ], + "signature": [ + "symbol" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.IContextContainer.registerContext.$2", + "type": "Uncategorized", + "tags": [], + "label": "contextName", + "description": [ + "- The key of the `TContext` object this provider supplies the value for." + ], + "signature": [ + "ContextName" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.IContextContainer.registerContext.$3", + "type": "Function", + "tags": [], + "label": "provider", + "description": [ + "- A {@link IContextProvider } to be called each time a new context is created." + ], + "signature": [ + "IContextProvider", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "The {@link IContextContainer } for method chaining." + ] + }, + { + "parentPluginId": "core", + "id": "def-server.IContextContainer.createHandler", + "type": "Function", + "tags": [], + "label": "createHandler", + "description": [ + "\nCreate a new handler function pre-wired to context for the plugin.\n" + ], + "signature": [ + "(pluginOpaqueId: symbol, handler: ", + "RequestHandler", + ") => (request: ", + "KibanaRequest", + ", response: ", + "KibanaResponseFactory", + ") => Promise<", + "IKibanaResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IContextContainer.createHandler.$1", + "type": "Uncategorized", + "tags": [], + "label": "pluginOpaqueId", + "description": [ + "- The plugin opaque ID for the plugin that registers this handler." + ], + "signature": [ + "symbol" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.IContextContainer.createHandler.$2", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "- Handler function to pass context object to." + ], + "signature": [ + "RequestHandler", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "A function that takes `RequestHandler` parameters, calls `handler` with a new context, and returns a Promise of\nthe `handler` return value." + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ICspConfig", + "type": "Interface", + "tags": [], + "label": "ICspConfig", + "description": [ + "\nCSP configuration for use in Kibana." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ICspConfig.strict", + "type": "boolean", + "tags": [], + "label": "strict", + "description": [ + "\nSpecify whether browsers that do not support CSP should be\nable to use Kibana. Use `true` to block and `false` to allow." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.ICspConfig.warnLegacyBrowsers", + "type": "boolean", + "tags": [], + "label": "warnLegacyBrowsers", + "description": [ + "\nSpecify whether users with legacy browsers should be warned\nabout their lack of Kibana security compliance." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.ICspConfig.disableEmbedding", + "type": "boolean", + "tags": [], + "label": "disableEmbedding", + "description": [ + "\nWhether or not embedding (using iframes) should be allowed by the CSP. If embedding is disabled, a restrictive 'frame-ancestors' rule will be added to the default CSP rules." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.ICspConfig.header", + "type": "string", + "tags": [], + "label": "header", + "description": [ + "\nThe CSP rules in a formatted directives string for use\nin a `Content-Security-Policy` header." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ICustomClusterClient", + "type": "Interface", + "tags": [], + "label": "ICustomClusterClient", + "description": [ + "\nSee {@link IClusterClient}\n" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ICustomClusterClient", + "text": "ICustomClusterClient" + }, + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IClusterClient", + "text": "IClusterClient" + } + ], + "path": "src/core/server/elasticsearch/client/cluster_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ICustomClusterClient.close", + "type": "Function", + "tags": [], + "label": "close", + "description": [ + "\nCloses the cluster client. After that client cannot be used and one should\ncreate a new client instance to be able to interact with Elasticsearch API." + ], + "signature": [ + "() => Promise" + ], + "path": "src/core/server/elasticsearch/client/cluster_client.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.IExecutionContextContainer", + "type": "Interface", + "tags": [], + "label": "IExecutionContextContainer", + "description": [], + "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IExecutionContextContainer.toString", + "type": "Function", + "tags": [], + "label": "toString", + "description": [], + "signature": [ + "() => string" + ], + "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.IExecutionContextContainer.toJSON", + "type": "Function", + "tags": [], + "label": "toJSON", + "description": [], + "signature": [ + "() => Readonly<", + "KibanaExecutionContext", + ">" + ], + "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.IExternalUrlConfig", + "type": "Interface", + "tags": [], + "label": "IExternalUrlConfig", + "description": [ + "\nExternal Url configuration for use in Kibana." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IExternalUrlConfig.policy", + "type": "Array", + "tags": [], + "label": "policy", + "description": [ + "\nA set of policies describing which external urls are allowed." + ], + "signature": [ + "IExternalUrlPolicy", + "[]" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.IExternalUrlPolicy", + "type": "Interface", + "tags": [], + "label": "IExternalUrlPolicy", + "description": [ + "\nA policy describing whether access to an external destination is allowed." + ], + "path": "node_modules/@types/kbn__core-http-common/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IExternalUrlPolicy.allow", + "type": "boolean", + "tags": [], + "label": "allow", + "description": [ + "\nIndicates if this policy allows or denies access to the described destination." + ], + "path": "node_modules/@types/kbn__core-http-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IExternalUrlPolicy.host", + "type": "string", + "tags": [], + "label": "host", + "description": [ + "\nOptional host describing the external destination.\nMay be combined with `protocol`.\n" + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-http-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IExternalUrlPolicy.protocol", + "type": "string", + "tags": [], + "label": "protocol", + "description": [ + "\nOptional protocol describing the external destination.\nMay be combined with `host`.\n" + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-http-common/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.IKibanaResponse", + "type": "Interface", + "tags": [], + "label": "IKibanaResponse", + "description": [ + "\nA response data object, expected to returned as a result of {@link RequestHandler} execution" + ], + "signature": [ + "IKibanaResponse", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IKibanaResponse.status", + "type": "number", + "tags": [], + "label": "status", + "description": [], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IKibanaResponse.payload", + "type": "Uncategorized", + "tags": [], + "label": "payload", + "description": [], + "signature": [ + "T | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IKibanaResponse.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "HttpResponseOptions" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket", + "type": "Interface", + "tags": [], + "label": "IKibanaSocket", + "description": [ + "\nA tiny abstraction for TCP socket." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.getPeerCertificate", + "type": "Function", + "tags": [], + "label": "getPeerCertificate", + "description": [], + "signature": [ + "{ (detailed: true): ", + "DetailedPeerCertificate", + " | null; (detailed: false): ", + "PeerCertificate", + " | null; (detailed?: boolean | undefined): ", + "PeerCertificate", + " | ", + "DetailedPeerCertificate", + " | null; }" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.getPeerCertificate.$1", + "type": "boolean", + "tags": [], + "label": "detailed", + "description": [], + "signature": [ + "true" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.getPeerCertificate", + "type": "Function", + "tags": [], + "label": "getPeerCertificate", + "description": [], + "signature": [ + "{ (detailed: true): ", + "DetailedPeerCertificate", + " | null; (detailed: false): ", + "PeerCertificate", + " | null; (detailed?: boolean | undefined): ", + "PeerCertificate", " | ", - "UpdateByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "UpdateByQueryRethrottleResponse", - ", unknown>>; (this: That, params: ", - "UpdateByQueryRethrottleRequest", + "DetailedPeerCertificate", + " | null; }" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.getPeerCertificate.$1", + "type": "boolean", + "tags": [], + "label": "detailed", + "description": [], + "signature": [ + "false" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.getPeerCertificate", + "type": "Function", + "tags": [], + "label": "getPeerCertificate", + "description": [ + "\nReturns an object representing the peer's certificate.\nThe returned object has some properties corresponding to the field of the certificate.\nIf detailed argument is true the full chain with issuer property will be returned,\nif false only the top certificate without issuer property.\nIf the peer does not provide a certificate, it returns null." + ], + "signature": [ + "{ (detailed: true): ", + "DetailedPeerCertificate", + " | null; (detailed: false): ", + "PeerCertificate", + " | null; (detailed?: boolean | undefined): ", + "PeerCertificate", " | ", - "UpdateByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "UpdateByQueryRethrottleResponse", - ">; }; watcher: ", - "default", - "; xpack: ", - "default", - "; }" + "DetailedPeerCertificate", + " | null; }" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.getPeerCertificate.$1", + "type": "CompoundType", + "tags": [], + "label": "detailed", + "description": [ + "- If true; the full chain with issuer property will be returned." + ], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "An object representing the peer's certificate." + ] + }, + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.getProtocol", + "type": "Function", + "tags": [], + "label": "getProtocol", + "description": [ + "\nReturns a string containing the negotiated SSL/TLS protocol version of the current connection. The value 'unknown' will be returned for\nconnected sockets that have not completed the handshaking process. The value null will be returned for server sockets or disconnected\nclient sockets. See https://www.openssl.org/docs/man1.0.2/ssl/SSL_get_version.html for more information." + ], + "signature": [ + "() => string | null" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.renegotiate", + "type": "Function", + "tags": [], + "label": "renegotiate", + "description": [ + "\nRenegotiates a connection to obtain the peer's certificate. This cannot be used when the protocol version is TLSv1.3." + ], + "signature": [ + "(options: { rejectUnauthorized?: boolean | undefined; requestCert?: boolean | undefined; }) => Promise" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.renegotiate.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.renegotiate.$1.rejectUnauthorized", + "type": "CompoundType", + "tags": [], + "label": "rejectUnauthorized", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.renegotiate.$1.requestCert", + "type": "CompoundType", + "tags": [], + "label": "requestCert", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ] + } ], - "path": "src/core/server/elasticsearch/client/cluster_client.ts", + "returnComment": [ + "A Promise that will be resolved if renegotiation succeeded, or will be rejected if renegotiation failed." + ] + }, + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.authorized", + "type": "CompoundType", + "tags": [], + "label": "authorized", + "description": [ + "\nIndicates whether or not the peer certificate was signed by one of the specified CAs. When TLS\nisn't used the value is `undefined`." + ], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.IClusterClient.asScoped", - "type": "Function", + "id": "def-server.IKibanaSocket.authorizationError", + "type": "Object", "tags": [], - "label": "asScoped", + "label": "authorizationError", "description": [ - "\nCreates a {@link IScopedClusterClient | scoped cluster client} bound to given {@link ScopeableRequest | request}" + "\nThe reason why the peer's certificate has not been verified. This property becomes available\nonly when `authorized` is `false`." ], "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ScopeableRequest", - "text": "ScopeableRequest" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IScopedClusterClient", - "text": "IScopedClusterClient" - } + "Error | undefined" ], - "path": "src/core/server/elasticsearch/client/cluster_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IClusterClient.asScoped.$1", - "type": "CompoundType", - "tags": [], - "label": "request", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ScopeableRequest", - "text": "ScopeableRequest" - } - ], - "path": "src/core/server/elasticsearch/client/cluster_client.ts", - "deprecated": false, - "isRequired": true - } + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.IntervalHistogram", + "type": "Interface", + "tags": [], + "label": "IntervalHistogram", + "description": [ + "\nan IntervalHistogram object that samples and reports the event loop delay over time.\nThe delays will be reported in milliseconds.\n" + ], + "path": "src/core/server/metrics/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IntervalHistogram.fromTimestamp", + "type": "string", + "tags": [], + "label": "fromTimestamp", + "description": [], + "path": "src/core/server/metrics/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IntervalHistogram.lastUpdatedAt", + "type": "string", + "tags": [], + "label": "lastUpdatedAt", + "description": [], + "path": "src/core/server/metrics/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IntervalHistogram.min", + "type": "number", + "tags": [], + "label": "min", + "description": [], + "path": "src/core/server/metrics/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IntervalHistogram.max", + "type": "number", + "tags": [], + "label": "max", + "description": [], + "path": "src/core/server/metrics/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IntervalHistogram.mean", + "type": "number", + "tags": [], + "label": "mean", + "description": [], + "path": "src/core/server/metrics/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IntervalHistogram.exceeds", + "type": "number", + "tags": [], + "label": "exceeds", + "description": [], + "path": "src/core/server/metrics/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IntervalHistogram.stddev", + "type": "number", + "tags": [], + "label": "stddev", + "description": [], + "path": "src/core/server/metrics/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IntervalHistogram.percentiles", + "type": "Object", + "tags": [], + "label": "percentiles", + "description": [], + "signature": [ + "{ 50: number; 75: number; 95: number; 99: number; }" ], - "returnComment": [] + "path": "src/core/server/metrics/types.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.IContextContainer", + "id": "def-server.IRenderOptions", "type": "Interface", "tags": [], - "label": "IContextContainer", + "label": "IRenderOptions", + "description": [], + "path": "src/core/server/rendering/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IRenderOptions.isAnonymousPage", + "type": "CompoundType", + "tags": [], + "label": "isAnonymousPage", + "description": [ + "\nSet whether the page is anonymous, which determines what plugins are enabled and whether to output user settings in the page metadata.\n`false` by default." + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/core/server/rendering/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter", + "type": "Interface", + "tags": [], + "label": "IRouter", "description": [ - "\nAn object that handles registration of context providers and configuring handlers with context.\n" + "\nRegisters route handlers for specified resource path and method.\nSee {@link RouteConfig} and {@link RequestHandler} for more information about arguments to route registrations.\n" ], - "path": "src/core/server/context/container/context.ts", + "signature": [ + "IRouter", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.IContextContainer.registerContext", + "id": "def-server.IRouter.routerPath", + "type": "string", + "tags": [], + "label": "routerPath", + "description": [ + "\nResulted path" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter.get", "type": "Function", "tags": [], - "label": "registerContext", + "label": "get", "description": [ - "\nRegister a new context provider.\n" + "\nRegister a route handler for `GET` request." ], "signature": [ - "(pluginOpaqueId: symbol, contextName: ContextName, provider: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IContextProvider", - "text": "IContextProvider" - }, - ") => this" + "(route: ", + "RouteConfig", + ", handler: ", + "RequestHandler", + ") => void" ], - "path": "src/core/server/context/container/context.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, + "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.IContextContainer.registerContext.$1", - "type": "Uncategorized", - "tags": [], - "label": "pluginOpaqueId", - "description": [ - "- The plugin opaque ID for the plugin that registers this context." - ], - "signature": [ - "symbol" - ], - "path": "src/core/server/context/container/context.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.IContextContainer.registerContext.$2", - "type": "Uncategorized", + "id": "def-server.IRouter.get.$1", + "type": "Object", "tags": [], - "label": "contextName", + "label": "route", "description": [ - "- The key of the `TContext` object this provider supplies the value for." + "{@link RouteConfig } - a route configuration." ], "signature": [ - "ContextName" + "RouteConfig", + "" ], - "path": "src/core/server/context/container/context.ts", - "deprecated": false, - "isRequired": true + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.IContextContainer.registerContext.$3", + "id": "def-server.IRouter.get.$2", "type": "Function", "tags": [], - "label": "provider", + "label": "handler", "description": [ - "- A {@link IContextProvider } to be called each time a new context is created." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IContextProvider", - "text": "IContextProvider" - }, - "" + "{@link RequestHandler } - a function to call to respond to an incoming request" ], - "path": "src/core/server/context/container/context.ts", + "signature": [ + "(context: Context, request: ", + "KibanaRequest", + ", response: ", + "KibanaResponseFactory", + ") => ", + "IKibanaResponse", + " | Promise<", + "IKibanaResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, - "isRequired": true + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IRouter.get.$2.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter.get.$2.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter.get.$2.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ] } - ], - "returnComment": [ - "The {@link IContextContainer } for method chaining." ] }, - { - "parentPluginId": "core", - "id": "def-server.IContextContainer.createHandler", - "type": "Function", - "tags": [], - "label": "createHandler", - "description": [ - "\nCreate a new handler function pre-wired to context for the plugin.\n" - ], - "signature": [ - "(pluginOpaqueId: symbol, handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.RequestHandler", - "text": "RequestHandler" - }, - " | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | 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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }>) => (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: { custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | 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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - ">" + { + "parentPluginId": "core", + "id": "def-server.IRouter.post", + "type": "Function", + "tags": [], + "label": "post", + "description": [ + "\nRegister a route handler for `POST` request." + ], + "signature": [ + "(route: ", + "RouteConfig", + ", handler: ", + "RequestHandler", + ") => void" ], - "path": "src/core/server/context/container/context.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, + "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.IContextContainer.createHandler.$1", - "type": "Uncategorized", + "id": "def-server.IRouter.post.$1", + "type": "Object", "tags": [], - "label": "pluginOpaqueId", + "label": "route", "description": [ - "- The plugin opaque ID for the plugin that registers this handler." + "{@link RouteConfig } - a route configuration." ], "signature": [ - "symbol" + "RouteConfig", + "" ], - "path": "src/core/server/context/container/context.ts", - "deprecated": false, - "isRequired": true + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.IContextContainer.createHandler.$2", + "id": "def-server.IRouter.post.$2", "type": "Function", "tags": [], "label": "handler", "description": [ - "- Handler function to pass context object to." + "{@link RequestHandler } - a function to call to respond to an incoming request" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.RequestHandler", - "text": "RequestHandler" - }, - " | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | 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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, + "(context: Context, request: ", + "KibanaRequest", + ", response: ", + "KibanaResponseFactory", ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", + "IKibanaResponse", + " | Promise<", + "IKibanaResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" + "parentPluginId": "core", + "id": "def-server.IRouter.post.$2.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" + "parentPluginId": "core", + "id": "def-server.IRouter.post.$2.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; 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, - "isRequired": true + "parentPluginId": "core", + "id": "def-server.IRouter.post.$2.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ] } - ], - "returnComment": [ - "A function that takes `RequestHandler` parameters, calls `handler` with a new context, and returns a Promise of\nthe `handler` return value." ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.ICustomClusterClient", - "type": "Interface", - "tags": [], - "label": "ICustomClusterClient", - "description": [ - "\nSee {@link IClusterClient}\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ICustomClusterClient", - "text": "ICustomClusterClient" }, - " extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IClusterClient", - "text": "IClusterClient" - } - ], - "path": "src/core/server/elasticsearch/client/cluster_client.ts", - "deprecated": false, - "children": [ { "parentPluginId": "core", - "id": "def-server.ICustomClusterClient.close", + "id": "def-server.IRouter.put", "type": "Function", "tags": [], - "label": "close", + "label": "put", "description": [ - "\nCloses the cluster client. After that client cannot be used and one should\ncreate a new client instance to be able to interact with Elasticsearch API." + "\nRegister a route handler for `PUT` request." ], "signature": [ - "() => Promise" + "(route: ", + "RouteConfig", + ", handler: ", + "RequestHandler", + ") => void" ], - "path": "src/core/server/elasticsearch/client/cluster_client.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.IExecutionContextContainer", - "type": "Interface", - "tags": [], - "label": "IExecutionContextContainer", - "description": [], - "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", - "deprecated": false, - "children": [ + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IRouter.put.$1", + "type": "Object", + "tags": [], + "label": "route", + "description": [ + "{@link RouteConfig } - a route configuration." + ], + "signature": [ + "RouteConfig", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter.put.$2", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link RequestHandler } - a function to call to respond to an incoming request" + ], + "signature": [ + "(context: Context, request: ", + "KibanaRequest", + ", response: ", + "KibanaResponseFactory", + ") => ", + "IKibanaResponse", + " | Promise<", + "IKibanaResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IRouter.put.$2.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter.put.$2.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter.put.$2.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ] + } + ] + }, { "parentPluginId": "core", - "id": "def-server.IExecutionContextContainer.toString", + "id": "def-server.IRouter.patch", "type": "Function", "tags": [], - "label": "toString", - "description": [], + "label": "patch", + "description": [ + "\nRegister a route handler for `PATCH` request." + ], "signature": [ - "() => string" + "(route: ", + "RouteConfig", + ", handler: ", + "RequestHandler", + ") => void" ], - "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, - "children": [], - "returnComment": [] + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IRouter.patch.$1", + "type": "Object", + "tags": [], + "label": "route", + "description": [ + "{@link RouteConfig } - a route configuration." + ], + "signature": [ + "RouteConfig", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter.patch.$2", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link RequestHandler } - a function to call to respond to an incoming request" + ], + "signature": [ + "(context: Context, request: ", + "KibanaRequest", + ", response: ", + "KibanaResponseFactory", + ") => ", + "IKibanaResponse", + " | Promise<", + "IKibanaResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IRouter.patch.$2.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter.patch.$2.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter.patch.$2.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ] + } + ] }, { "parentPluginId": "core", - "id": "def-server.IExecutionContextContainer.toJSON", + "id": "def-server.IRouter.delete", "type": "Function", "tags": [], - "label": "toJSON", - "description": [], + "label": "delete", + "description": [ + "\nRegister a route handler for `DELETE` request." + ], "signature": [ - "() => Readonly<", - "KibanaExecutionContext", - ">" + "(route: ", + "RouteConfig", + ", handler: ", + "RequestHandler", + ") => void" ], - "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.IntervalHistogram", - "type": "Interface", - "tags": [], - "label": "IntervalHistogram", - "description": [ - "\nan IntervalHistogram object that samples and reports the event loop delay over time.\nThe delays will be reported in milliseconds.\n" - ], - "path": "src/core/server/metrics/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IntervalHistogram.fromTimestamp", - "type": "string", - "tags": [], - "label": "fromTimestamp", - "description": [], - "path": "src/core/server/metrics/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IntervalHistogram.lastUpdatedAt", - "type": "string", - "tags": [], - "label": "lastUpdatedAt", - "description": [], - "path": "src/core/server/metrics/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IntervalHistogram.min", - "type": "number", - "tags": [], - "label": "min", - "description": [], - "path": "src/core/server/metrics/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IntervalHistogram.max", - "type": "number", - "tags": [], - "label": "max", - "description": [], - "path": "src/core/server/metrics/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IntervalHistogram.mean", - "type": "number", - "tags": [], - "label": "mean", - "description": [], - "path": "src/core/server/metrics/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IntervalHistogram.exceeds", - "type": "number", - "tags": [], - "label": "exceeds", - "description": [], - "path": "src/core/server/metrics/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IntervalHistogram.stddev", - "type": "number", - "tags": [], - "label": "stddev", - "description": [], - "path": "src/core/server/metrics/types.ts", - "deprecated": false + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IRouter.delete.$1", + "type": "Object", + "tags": [], + "label": "route", + "description": [ + "{@link RouteConfig } - a route configuration." + ], + "signature": [ + "RouteConfig", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter.delete.$2", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link RequestHandler } - a function to call to respond to an incoming request" + ], + "signature": [ + "(context: Context, request: ", + "KibanaRequest", + ", response: ", + "KibanaResponseFactory", + ") => ", + "IKibanaResponse", + " | Promise<", + "IKibanaResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IRouter.delete.$2.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter.delete.$2.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter.delete.$2.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ] + } + ] }, { "parentPluginId": "core", - "id": "def-server.IntervalHistogram.percentiles", - "type": "Object", - "tags": [], - "label": "percentiles", - "description": [], - "signature": [ - "{ 50: number; 75: number; 95: number; 99: number; }" - ], - "path": "src/core/server/metrics/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.IRenderOptions", - "type": "Interface", - "tags": [], - "label": "IRenderOptions", - "description": [], - "path": "src/core/server/rendering/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IRenderOptions.isAnonymousPage", - "type": "CompoundType", + "id": "def-server.IRouter.handleLegacyErrors", + "type": "Function", "tags": [], - "label": "isAnonymousPage", + "label": "handleLegacyErrors", "description": [ - "\nSet whether the page is anonymous, which determines what plugins are enabled and whether to output user settings in the page metadata.\n`false` by default." + "\nWrap a router handler to catch and converts legacy boom errors to proper custom errors." ], "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/rendering/types.ts", - "deprecated": false + "(handler: ", + "RequestHandler", + ") => ", + "RequestHandler", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IRouter.handleLegacyErrors.$1", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link RequestHandler } - a route handler to wrap" + ], + "signature": [ + "(context: Context, request: ", + "KibanaRequest", + ", response: ResponseFactory) => ", + "IKibanaResponse", + " | Promise<", + "IKibanaResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IRouter.handleLegacyErrors.$1.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter.handleLegacyErrors.$1.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter.handleLegacyErrors.$1.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ] + } + ] } ], "initialIsOpen": false @@ -18401,7 +21850,325 @@ "isRequired": true } ], - "returnComment": [] + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequest", + "type": "Interface", + "tags": [], + "label": "KibanaRequest", + "description": [ + "\nKibana specific abstraction for an incoming request." + ], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.KibanaRequest.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "\nA identifier to identify this request.\n" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequest.uuid", + "type": "string", + "tags": [], + "label": "uuid", + "description": [ + "\nA UUID to identify this request.\n" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequest.url", + "type": "Object", + "tags": [], + "label": "url", + "description": [ + "a WHATWG URL standard object." + ], + "signature": [ + "URL" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequest.route", + "type": "Object", + "tags": [], + "label": "route", + "description": [ + "matched route details" + ], + "signature": [ + "{ readonly path: string; readonly method: ", + "RecursiveReadonly", + "; readonly options: ", + "RecursiveReadonly", + "<", + "KibanaRequestRouteOptions", + ">; }" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequest.headers", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [ + "\nReadonly copy of incoming request headers." + ], + "signature": [ + "{ warning?: string | string[] | undefined; from?: string | string[] | undefined; date?: string | string[] | undefined; expires?: string | string[] | undefined; range?: string | string[] | undefined; origin?: string | string[] | undefined; location?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; etag?: string | string[] | undefined; authorization?: string | string[] | undefined; connection?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequest.isSystemRequest", + "type": "boolean", + "tags": [], + "label": "isSystemRequest", + "description": [ + "\nWhether or not the request is a \"system request\" rather than an application-level request.\nCan be set on the client using the `HttpFetchOptions#asSystemRequest` option." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequest.socket", + "type": "Object", + "tags": [], + "label": "socket", + "description": [ + "\nThe socket associated with this request.\nSee {@link IKibanaSocket}." + ], + "signature": [ + "IKibanaSocket" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequest.events", + "type": "Object", + "tags": [], + "label": "events", + "description": [ + "\nAllow to listen to events bound to this request.\nSee {@link KibanaRequestEvents}." + ], + "signature": [ + "KibanaRequestEvents" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequest.auth", + "type": "Object", + "tags": [], + "label": "auth", + "description": [ + "\nThe auth status of this request.\nSee {@link KibanaRequestAuth}." + ], + "signature": [ + "KibanaRequestAuth" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequest.rewrittenUrl", + "type": "Object", + "tags": [], + "label": "rewrittenUrl", + "description": [ + "\nURL rewritten in onPreRouting request interceptor." + ], + "signature": [ + "URL", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequest.params", + "type": "Uncategorized", + "tags": [], + "label": "params", + "description": [ + "\nThe path parameter of this request." + ], + "signature": [ + "Params" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequest.query", + "type": "Uncategorized", + "tags": [], + "label": "query", + "description": [ + "\nThe query parameter of this request." + ], + "signature": [ + "Query" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequest.body", + "type": "Uncategorized", + "tags": [], + "label": "body", + "description": [ + "\nThe body payload of this request." + ], + "signature": [ + "Body" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequestEvents", + "type": "Interface", + "tags": [], + "label": "KibanaRequestEvents", + "description": [ + "\nRequest events." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.KibanaRequestEvents.aborted$", + "type": "Object", + "tags": [], + "label": "aborted$", + "description": [ + "\nObservable that emits once if and when the request has been aborted." + ], + "signature": [ + "Observable", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequestEvents.completed$", + "type": "Object", + "tags": [], + "label": "completed$", + "description": [ + "\nObservable that emits once if and when the request has been completely handled.\n" + ], + "signature": [ + "Observable", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequestRoute", + "type": "Interface", + "tags": [], + "label": "KibanaRequestRoute", + "description": [ + "\nRequest specific route information exposed to a handler." + ], + "signature": [ + "KibanaRequestRoute", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.KibanaRequestRoute.path", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequestRoute.method", + "type": "Uncategorized", + "tags": [], + "label": "method", + "description": [], + "signature": [ + "Method" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequestRoute.options", + "type": "Uncategorized", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "Method extends \"options\" | \"get\" ? Required, \"body\">> : Required<", + "RouteConfigOptions", + ">" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false } ], "initialIsOpen": false @@ -19084,105 +22851,416 @@ "description": [ "\nThe backgroundTasks role includes operations which don't involve\nresponding to incoming http traffic from the UI." ], - "path": "node_modules/@types/kbn__core-node-server/index.d.ts", - "deprecated": false + "path": "node_modules/@types/kbn__core-node-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.NodeRoles.ui", + "type": "boolean", + "tags": [], + "label": "ui", + "description": [ + "\nThe ui role covers any operations that need to occur in order\nto handle http traffic from the browser." + ], + "path": "node_modules/@types/kbn__core-node-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.NodesVersionCompatibility", + "type": "Interface", + "tags": [], + "label": "NodesVersionCompatibility", + "description": [], + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.NodesVersionCompatibility.isCompatible", + "type": "boolean", + "tags": [], + "label": "isCompatible", + "description": [], + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.NodesVersionCompatibility.message", + "type": "string", + "tags": [], + "label": "message", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.NodesVersionCompatibility.incompatibleNodes", + "type": "Array", + "tags": [], + "label": "incompatibleNodes", + "description": [], + "signature": [ + "NodeInfo[]" + ], + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.NodesVersionCompatibility.warningNodes", + "type": "Array", + "tags": [], + "label": "warningNodes", + "description": [], + "signature": [ + "NodeInfo[]" + ], + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.NodesVersionCompatibility.kibanaVersion", + "type": "string", + "tags": [], + "label": "kibanaVersion", + "description": [], + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.NodesVersionCompatibility.nodesInfoRequestError", + "type": "Object", + "tags": [], + "label": "nodesInfoRequestError", + "description": [], + "signature": [ + "Error | undefined" + ], + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.OnPostAuthToolkit", + "type": "Interface", + "tags": [], + "label": "OnPostAuthToolkit", + "description": [], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.OnPostAuthToolkit.next", + "type": "Function", + "tags": [], + "label": "next", + "description": [ + "To pass request to the next handler" + ], + "signature": [ + "() => ", + "OnPostAuthNextResult" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.OnPreAuthToolkit", + "type": "Interface", + "tags": [], + "label": "OnPreAuthToolkit", + "description": [], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.OnPreAuthToolkit.next", + "type": "Function", + "tags": [], + "label": "next", + "description": [ + "To pass request to the next handler" + ], + "signature": [ + "() => ", + "OnPreAuthNextResult" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.OnPreResponseExtensions", + "type": "Interface", + "tags": [], + "label": "OnPreResponseExtensions", + "description": [ + "\nAdditional data to extend a response." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.OnPreResponseExtensions.headers", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [ + "additional headers to attach to the response" + ], + "signature": [ + "ResponseHeaders", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.OnPreResponseInfo", + "type": "Interface", + "tags": [], + "label": "OnPreResponseInfo", + "description": [ + "\nResponse status code." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.OnPreResponseInfo.statusCode", + "type": "number", + "tags": [], + "label": "statusCode", + "description": [], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.OnPreResponseRender", + "type": "Interface", + "tags": [], + "label": "OnPreResponseRender", + "description": [ + "\nAdditional data to extend a response when rendering a new body" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.OnPreResponseRender.headers", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [ + "additional headers to attach to the response" + ], + "signature": [ + "ResponseHeaders", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.OnPreResponseRender.body", + "type": "string", + "tags": [], + "label": "body", + "description": [ + "the body to use in the response" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.OnPreResponseToolkit", + "type": "Interface", + "tags": [], + "label": "OnPreResponseToolkit", + "description": [ + "\nA tool set defining an outcome of OnPreResponse interceptor for incoming request." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.OnPreResponseToolkit.render", + "type": "Function", + "tags": [], + "label": "render", + "description": [ + "To override the response with a different body" + ], + "signature": [ + "(responseRender: ", + "OnPreResponseRender", + ") => ", + "OnPreResponseResult" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.OnPreResponseToolkit.render.$1", + "type": "Object", + "tags": [], + "label": "responseRender", + "description": [], + "signature": [ + "OnPreResponseRender" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.NodeRoles.ui", - "type": "boolean", + "id": "def-server.OnPreResponseToolkit.next", + "type": "Function", "tags": [], - "label": "ui", + "label": "next", "description": [ - "\nThe ui role covers any operations that need to occur in order\nto handle http traffic from the browser." + "To pass request to the next handler" ], - "path": "node_modules/@types/kbn__core-node-server/index.d.ts", - "deprecated": false + "signature": [ + "(responseExtensions?: ", + "OnPreResponseExtensions", + " | undefined) => ", + "OnPreResponseResult" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.OnPreResponseToolkit.next.$1", + "type": "Object", + "tags": [], + "label": "responseExtensions", + "description": [], + "signature": [ + "OnPreResponseExtensions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.NodesVersionCompatibility", + "id": "def-server.OnPreRoutingToolkit", "type": "Interface", "tags": [], - "label": "NodesVersionCompatibility", + "label": "OnPreRoutingToolkit", "description": [], - "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.NodesVersionCompatibility.isCompatible", - "type": "boolean", - "tags": [], - "label": "isCompatible", - "description": [], - "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.NodesVersionCompatibility.message", - "type": "string", + "id": "def-server.OnPreRoutingToolkit.next", + "type": "Function", "tags": [], - "label": "message", - "description": [], - "signature": [ - "string | undefined" + "label": "next", + "description": [ + "To pass request to the next handler" ], - "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.NodesVersionCompatibility.incompatibleNodes", - "type": "Array", - "tags": [], - "label": "incompatibleNodes", - "description": [], "signature": [ - "NodeInfo[]" + "() => ", + "OnPreRoutingResult" ], - "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", - "deprecated": false + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.NodesVersionCompatibility.warningNodes", - "type": "Array", + "id": "def-server.OnPreRoutingToolkit.rewriteUrl", + "type": "Function", "tags": [], - "label": "warningNodes", - "description": [], - "signature": [ - "NodeInfo[]" + "label": "rewriteUrl", + "description": [ + "Rewrite requested resources url before is was authenticated and routed to a handler" ], - "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.NodesVersionCompatibility.kibanaVersion", - "type": "string", - "tags": [], - "label": "kibanaVersion", - "description": [], - "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.NodesVersionCompatibility.nodesInfoRequestError", - "type": "Object", - "tags": [], - "label": "nodesInfoRequestError", - "description": [], "signature": [ - "Error | undefined" + "(url: string) => ", + "OnPreRoutingResult" ], - "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", - "deprecated": false + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.OnPreRoutingToolkit.rewriteUrl.$1", + "type": "string", + "tags": [], + "label": "url", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -21527,65 +25605,464 @@ " | undefined): Promise<", "TransportResult", "<", - "UpdateByQueryRethrottleResponse", - ", unknown>>; (this: That, params: ", - "UpdateByQueryRethrottleRequest", - " | ", - "UpdateByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "UpdateByQueryRethrottleResponse", - ">; }; watcher: ", - "default", - "; xpack: ", - "default", - "; }" + "UpdateByQueryRethrottleResponse", + ", unknown>>; (this: That, params: ", + "UpdateByQueryRethrottleRequest", + " | ", + "UpdateByQueryRethrottleRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "UpdateByQueryRethrottleResponse", + ">; }; watcher: ", + "default", + "; xpack: ", + "default", + "; }" + ], + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.PollEsNodesVersionOptions.log", + "type": "Object", + "tags": [], + "label": "log", + "description": [], + "signature": [ + "Logger" + ], + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.PollEsNodesVersionOptions.kibanaVersion", + "type": "string", + "tags": [], + "label": "kibanaVersion", + "description": [], + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.PollEsNodesVersionOptions.ignoreVersionMismatch", + "type": "boolean", + "tags": [], + "label": "ignoreVersionMismatch", + "description": [], + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.PollEsNodesVersionOptions.esVersionCheckInterval", + "type": "number", + "tags": [], + "label": "esVersionCheckInterval", + "description": [], + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.PrebootPlugin", + "type": "Interface", + "tags": [], + "label": "PrebootPlugin", + "description": [ + "\nThe interface that should be returned by a `PluginInitializer` for a `preboot` plugin.\n" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.PrebootPlugin", + "text": "PrebootPlugin" + }, + "" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.PrebootPlugin.setup", + "type": "Function", + "tags": [], + "label": "setup", + "description": [], + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CorePreboot", + "text": "CorePreboot" + }, + ", plugins: TPluginsSetup) => TSetup" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.PrebootPlugin.setup.$1", + "type": "Object", + "tags": [], + "label": "core", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CorePreboot", + "text": "CorePreboot" + } + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.PrebootPlugin.setup.$2", + "type": "Uncategorized", + "tags": [], + "label": "plugins", + "description": [], + "signature": [ + "TPluginsSetup" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.PrebootPlugin.stop", + "type": "Function", + "tags": [], + "label": "stop", + "description": [], + "signature": [ + "(() => void) | undefined" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.RegisterDeprecationsConfig", + "type": "Interface", + "tags": [], + "label": "RegisterDeprecationsConfig", + "description": [], + "path": "src/core/server/deprecations/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.RegisterDeprecationsConfig.getDeprecations", + "type": "Function", + "tags": [], + "label": "getDeprecations", + "description": [], + "signature": [ + "(context: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.GetDeprecationsContext", + "text": "GetDeprecationsContext" + }, + ") => ", + "MaybePromise", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.DeprecationsDetails", + "text": "DeprecationsDetails" + }, + "[]>" ], - "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", - "deprecated": false + "path": "src/core/server/deprecations/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.RegisterDeprecationsConfig.getDeprecations.$1", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.GetDeprecationsContext", + "text": "GetDeprecationsContext" + } + ], + "path": "src/core/server/deprecations/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.RequestHandlerContext", + "type": "Interface", + "tags": [], + "label": "RequestHandlerContext", + "description": [ + "\nBase context passed to a route handler, containing the `core` context part.\n" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.RequestHandlerContext", + "text": "RequestHandlerContext" }, + " extends ", + "RequestHandlerContextBase" + ], + "path": "src/core/server/index.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.PollEsNodesVersionOptions.log", + "id": "def-server.RequestHandlerContext.core", "type": "Object", "tags": [], - "label": "log", + "label": "core", "description": [], "signature": [ - "Logger" + "Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreRequestHandlerContext", + "text": "CoreRequestHandlerContext" + }, + ">" ], - "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "path": "src/core/server/index.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ResolveCapabilitiesOptions", + "type": "Interface", + "tags": [], + "label": "ResolveCapabilitiesOptions", + "description": [ + "\nDefines a set of additional options for the `resolveCapabilities` method of {@link CapabilitiesStart}.\n" + ], + "path": "src/core/server/capabilities/capabilities_service.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.PollEsNodesVersionOptions.kibanaVersion", + "id": "def-server.ResolveCapabilitiesOptions.useDefaultCapabilities", + "type": "boolean", + "tags": [], + "label": "useDefaultCapabilities", + "description": [ + "\nIndicates if capability switchers are supposed to return a default set of capabilities." + ], + "path": "src/core/server/capabilities/capabilities_service.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteConfig", + "type": "Interface", + "tags": [], + "label": "RouteConfig", + "description": [ + "\nRoute specific configuration." + ], + "signature": [ + "RouteConfig", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.RouteConfig.path", "type": "string", "tags": [], - "label": "kibanaVersion", - "description": [], - "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "label": "path", + "description": [ + "\nThe endpoint _within_ the router path to register the route.\n" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.PollEsNodesVersionOptions.ignoreVersionMismatch", - "type": "boolean", + "id": "def-server.RouteConfig.validate", + "type": "CompoundType", "tags": [], - "label": "ignoreVersionMismatch", - "description": [], - "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "label": "validate", + "description": [ + "\nA schema created with `@kbn/config-schema` that every request will be validated against.\n" + ], + "signature": [ + "false | ", + "RouteValidatorFullConfig", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteConfig.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "\nAdditional route options {@link RouteConfigOptions}." + ], + "signature": [ + "RouteConfigOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteConfigOptions", + "type": "Interface", + "tags": [], + "label": "RouteConfigOptions", + "description": [ + "\nAdditional route options." + ], + "signature": [ + "RouteConfigOptions", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.RouteConfigOptions.authRequired", + "type": "CompoundType", + "tags": [], + "label": "authRequired", + "description": [ + "\nDefines authentication mode for a route:\n- true. A user has to have valid credentials to access a resource\n- false. A user can access a resource without any credentials.\n- 'optional'. A user can access a resource, and will be authenticated if provided credentials are valid.\n Can be useful when we grant access to a resource but want to identify a user if possible.\n\nDefaults to `true` if an auth mechanism is registered." + ], + "signature": [ + "boolean | \"optional\" | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteConfigOptions.xsrfRequired", + "type": "Uncategorized", + "tags": [], + "label": "xsrfRequired", + "description": [ + "\nDefines xsrf protection requirements for a route:\n- true. Requires an incoming POST/PUT/DELETE request to contain `kbn-xsrf` header.\n- false. Disables xsrf protection.\n\nSet to true by default" + ], + "signature": [ + "(Method extends \"get\" ? never : boolean) | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteConfigOptions.tags", + "type": "Object", + "tags": [], + "label": "tags", + "description": [ + "\nAdditional metadata tag strings to attach to the route." + ], + "signature": [ + "readonly string[] | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteConfigOptions.body", + "type": "Uncategorized", + "tags": [], + "label": "body", + "description": [ + "\nAdditional body options {@link RouteConfigOptionsBody}." + ], + "signature": [ + "(Method extends \"options\" | \"get\" ? undefined : ", + "RouteConfigOptionsBody", + ") | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.PollEsNodesVersionOptions.esVersionCheckInterval", - "type": "number", + "id": "def-server.RouteConfigOptions.timeout", + "type": "Object", "tags": [], - "label": "esVersionCheckInterval", - "description": [], - "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "label": "timeout", + "description": [ + "\nDefines per-route timeouts." + ], + "signature": [ + "{ payload?: (Method extends \"options\" | \"get\" ? undefined : number) | undefined; idleSocket?: number | undefined; } | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false } ], @@ -21593,375 +26070,264 @@ }, { "parentPluginId": "core", - "id": "def-server.PrebootPlugin", + "id": "def-server.RouteConfigOptionsBody", "type": "Interface", "tags": [], - "label": "PrebootPlugin", + "label": "RouteConfigOptionsBody", "description": [ - "\nThe interface that should be returned by a `PluginInitializer` for a `preboot` plugin.\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.PrebootPlugin", - "text": "PrebootPlugin" - }, - "" + "\nAdditional body options for a route" ], - "path": "src/core/server/plugins/types.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.PrebootPlugin.setup", - "type": "Function", + "id": "def-server.RouteConfigOptionsBody.accepts", + "type": "CompoundType", "tags": [], - "label": "setup", - "description": [], - "signature": [ - "(core: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CorePreboot", - "text": "CorePreboot" - }, - ", plugins: TPluginsSetup) => TSetup" + "label": "accepts", + "description": [ + "\nA string or an array of strings with the allowed mime types for the endpoint. Use this settings to limit the set of allowed mime types. Note that allowing additional mime types not listed\nabove will not enable them to be parsed, and if parse is true, the request will result in an error response.\n\nDefault value: allows parsing of the following mime types:\n* application/json\n* application/*+json\n* application/octet-stream\n* application/x-www-form-urlencoded\n* multipart/form-data\n* text/*" ], - "path": "src/core/server/plugins/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.PrebootPlugin.setup.$1", - "type": "Object", - "tags": [], - "label": "core", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CorePreboot", - "text": "CorePreboot" - } - ], - "path": "src/core/server/plugins/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.PrebootPlugin.setup.$2", - "type": "Uncategorized", - "tags": [], - "label": "plugins", - "description": [], - "signature": [ - "TPluginsSetup" - ], - "path": "src/core/server/plugins/types.ts", - "deprecated": false, - "isRequired": true - } + "signature": [ + "string | string[] | ", + "RouteContentType", + "[] | undefined" ], - "returnComment": [] + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.PrebootPlugin.stop", - "type": "Function", + "id": "def-server.RouteConfigOptionsBody.maxBytes", + "type": "number", "tags": [], - "label": "stop", - "description": [], + "label": "maxBytes", + "description": [ + "\nLimits the size of incoming payloads to the specified byte count. Allowing very large payloads may cause the server to run out of memory.\n\nDefault value: The one set in the kibana.yml config file under the parameter `server.maxPayload`." + ], "signature": [ - "(() => void) | undefined" + "number | undefined" ], - "path": "src/core/server/plugins/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.PrebootServicePreboot", - "type": "Interface", - "tags": [], - "label": "PrebootServicePreboot", - "description": [ - "\nKibana Preboot Service allows to control the boot flow of Kibana. Preboot plugins can use it to hold the boot until certain condition is met.\n" - ], - "path": "src/core/server/preboot/types.ts", - "deprecated": false, - "children": [ + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, { "parentPluginId": "core", - "id": "def-server.PrebootServicePreboot.isSetupOnHold", - "type": "Function", + "id": "def-server.RouteConfigOptionsBody.output", + "type": "CompoundType", "tags": [], - "label": "isSetupOnHold", + "label": "output", "description": [ - "\nIndicates whether Kibana is currently on hold and cannot proceed to `setup` yet." + "\nThe processed payload format. The value must be one of:\n* 'data' - the incoming payload is read fully into memory. If parse is true, the payload is parsed (JSON, form-decoded, multipart) based on the 'Content-Type' header. If parse is false, a raw\nBuffer is returned.\n* 'stream' - the incoming payload is made available via a Stream.Readable interface. If the payload is 'multipart/form-data' and parse is true, field values are presented as text while files\nare provided as streams. File streams from a 'multipart/form-data' upload will also have a hapi property containing the filename and headers properties. Note that payload streams for multipart\npayloads are a synthetic interface created on top of the entire multipart content loaded into memory. To avoid loading large multipart payloads into memory, set parse to false and handle the\nmultipart payload in the handler using a streaming parser (e.g. pez).\n\nDefault value: 'data', unless no validation.body is provided in the route definition. In that case the default is 'stream' to alleviate memory pressure." ], "signature": [ - "() => boolean" + "\"data\" | \"stream\" | undefined" ], - "path": "src/core/server/preboot/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.PrebootServicePreboot.holdSetupUntilResolved", - "type": "Function", + "id": "def-server.RouteConfigOptionsBody.parse", + "type": "CompoundType", "tags": [], - "label": "holdSetupUntilResolved", + "label": "parse", "description": [ - "\nRegisters a `Promise` as a precondition before Kibana can proceed to `setup`. This method can be invoked multiple\ntimes and from multiple `preboot` plugins. Kibana will proceed to `setup` only when all registered `Promises`\ninstances are resolved, or it will shut down if any of them is rejected." + "\nDetermines if the incoming payload is processed or presented raw. Available values:\n* true - if the request 'Content-Type' matches the allowed mime types set by allow (for the whole payload as well as parts), the payload is converted into an object when possible. If the\nformat is unknown, a Bad Request (400) error response is sent. Any known content encoding is decoded.\n* false - the raw payload is returned unmodified.\n* 'gunzip' - the raw payload is returned unmodified after any known content encoding is decoded.\n\nDefault value: true, unless no validation.body is provided in the route definition. In that case the default is false to alleviate memory pressure." ], "signature": [ - "(reason: string, promise: Promise<{ shouldReloadConfig: boolean; } | undefined>) => void" - ], - "path": "src/core/server/preboot/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "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, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.PrebootServicePreboot.holdSetupUntilResolved.$2", - "type": "Object", - "tags": [], - "label": "promise", - "description": [ - "A `Promise` that should resolved before Kibana can proceed to `setup`." - ], - "signature": [ - "Promise<{ shouldReloadConfig: boolean; } | undefined>" - ], - "path": "src/core/server/preboot/types.ts", - "deprecated": false, - "isRequired": true - } + "boolean | \"gunzip\" | undefined" ], - "returnComment": [] + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.RegisterDeprecationsConfig", + "id": "def-server.RouteValidationResultFactory", "type": "Interface", "tags": [], - "label": "RegisterDeprecationsConfig", - "description": [], - "path": "src/core/server/deprecations/types.ts", + "label": "RouteValidationResultFactory", + "description": [ + "\nValidation result factory to be used in the custom validation function to return the valid data or validation errors\n\nSee {@link RouteValidationFunction}.\n" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.RegisterDeprecationsConfig.getDeprecations", + "id": "def-server.RouteValidationResultFactory.ok", "type": "Function", "tags": [], - "label": "getDeprecations", + "label": "ok", "description": [], "signature": [ - "(context: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.GetDeprecationsContext", - "text": "GetDeprecationsContext" - }, - ") => ", - "MaybePromise", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.DeprecationsDetails", - "text": "DeprecationsDetails" - }, - "[]>" + "(value: T) => { value: T; }" ], - "path": "src/core/server/deprecations/types.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.RegisterDeprecationsConfig.getDeprecations.$1", - "type": "Object", + "id": "def-server.RouteValidationResultFactory.ok.$1", + "type": "Uncategorized", "tags": [], - "label": "context", + "label": "value", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.GetDeprecationsContext", - "text": "GetDeprecationsContext" - } + "T" ], - "path": "src/core/server/deprecations/types.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RequestHandlerContext", - "type": "Interface", - "tags": [], - "label": "RequestHandlerContext", - "description": [ - "\nBase context passed to a route handler, containing the `core` context part.\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.RequestHandlerContext", - "text": "RequestHandlerContext" }, - " extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.RequestHandlerContextBase", - "text": "RequestHandlerContextBase" - } - ], - "path": "src/core/server/index.ts", - "deprecated": false, - "children": [ { "parentPluginId": "core", - "id": "def-server.RequestHandlerContext.core", - "type": "Object", + "id": "def-server.RouteValidationResultFactory.badRequest", + "type": "Function", "tags": [], - "label": "core", + "label": "badRequest", "description": [], "signature": [ - "Promise<", + "(error: string | Error, path?: string[] | undefined) => { error: ", + "RouteValidationError", + "; }" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreRequestHandlerContext", - "text": "CoreRequestHandlerContext" + "parentPluginId": "core", + "id": "def-server.RouteValidationResultFactory.badRequest.$1", + "type": "CompoundType", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "string | Error" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true }, - ">" + { + "parentPluginId": "core", + "id": "def-server.RouteValidationResultFactory.badRequest.$2", + "type": "Array", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": false + } ], - "path": "src/core/server/index.ts", - "deprecated": false + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.RequestHandlerContextBase", + "id": "def-server.RouteValidatorConfig", "type": "Interface", "tags": [], - "label": "RequestHandlerContextBase", + "label": "RouteValidatorConfig", "description": [ - "\nBase, abstract type for request handler contexts." + "\nThe configuration object to the RouteValidator class.\nSet `params`, `query` and/or `body` to specify the validation logic to follow for that property.\n" ], - "path": "src/core/server/index.ts", + "signature": [ + "RouteValidatorConfig", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.RequestHandlerContextBase.resolve", - "type": "Function", + "id": "def-server.RouteValidatorConfig.params", + "type": "CompoundType", "tags": [], - "label": "resolve", + "label": "params", "description": [ - "\nAwait all the specified context parts and return them.\n" + "\nValidation logic for the URL params" ], "signature": [ - ">(parts: T[]) => Promise<", - "AwaitedProperties", - ">>" + "RouteValidationSpec", + "

| undefined" ], - "path": "src/core/server/index.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RequestHandlerContextBase.resolve.$1", - "type": "Array", - "tags": [], - "label": "parts", - "description": [], - "signature": [ - "T[]" - ], - "path": "src/core/server/index.ts", - "deprecated": false, - "isRequired": true - } + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteValidatorConfig.query", + "type": "CompoundType", + "tags": [], + "label": "query", + "description": [ + "\nValidation logic for the Query params" ], - "returnComment": [] + "signature": [ + "RouteValidationSpec", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteValidatorConfig.body", + "type": "CompoundType", + "tags": [], + "label": "body", + "description": [ + "\nValidation logic for the body payload" + ], + "signature": [ + "RouteValidationSpec", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.ResolveCapabilitiesOptions", + "id": "def-server.RouteValidatorOptions", "type": "Interface", "tags": [], - "label": "ResolveCapabilitiesOptions", + "label": "RouteValidatorOptions", "description": [ - "\nDefines a set of additional options for the `resolveCapabilities` method of {@link CapabilitiesStart}.\n" + "\nAdditional options for the RouteValidator class to modify its default behaviour.\n" ], - "path": "src/core/server/capabilities/capabilities_service.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.ResolveCapabilitiesOptions.useDefaultCapabilities", - "type": "boolean", + "id": "def-server.RouteValidatorOptions.unsafe", + "type": "Object", "tags": [], - "label": "useDefaultCapabilities", + "label": "unsafe", "description": [ - "\nIndicates if capability switchers are supposed to return a default set of capabilities." + "\nSet the `unsafe` config to avoid running some additional internal *safe* validations on top of your custom validation" ], - "path": "src/core/server/capabilities/capabilities_service.ts", + "signature": [ + "{ params?: boolean | undefined; query?: boolean | undefined; body?: boolean | undefined; } | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false } ], @@ -22337,8 +26703,294 @@ "signature": [ "Meta | undefined" ], - "path": "src/core/server/status/types.ts", - "deprecated": false + "path": "src/core/server/status/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SessionCookieValidationResult", + "type": "Interface", + "tags": [], + "label": "SessionCookieValidationResult", + "description": [ + "\nReturn type from a function to validate cookie contents." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SessionCookieValidationResult.isValid", + "type": "boolean", + "tags": [], + "label": "isValid", + "description": [ + "\nWhether the cookie is valid or not." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SessionCookieValidationResult.path", + "type": "string", + "tags": [], + "label": "path", + "description": [ + "\nThe \"Path\" attribute of the cookie; if the cookie is invalid, this is used to clear it." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SessionStorage", + "type": "Interface", + "tags": [], + "label": "SessionStorage", + "description": [ + "\nProvides an interface to store and retrieve data across requests." + ], + "signature": [ + "SessionStorage", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SessionStorage.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [ + "\nRetrieves session value from the session storage." + ], + "signature": [ + "() => Promise" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SessionStorage.set", + "type": "Function", + "tags": [], + "label": "set", + "description": [ + "\nPuts current session value into the session storage." + ], + "signature": [ + "(sessionValue: T) => void" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SessionStorage.set.$1", + "type": "Uncategorized", + "tags": [], + "label": "sessionValue", + "description": [ + "- value to put" + ], + "signature": [ + "T" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SessionStorage.clear", + "type": "Function", + "tags": [], + "label": "clear", + "description": [ + "\nClears current session." + ], + "signature": [ + "() => void" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SessionStorageCookieOptions", + "type": "Interface", + "tags": [], + "label": "SessionStorageCookieOptions", + "description": [ + "\nConfiguration used to create HTTP session storage based on top of cookie mechanism." + ], + "signature": [ + "SessionStorageCookieOptions", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SessionStorageCookieOptions.name", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "\nName of the session cookie." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SessionStorageCookieOptions.encryptionKey", + "type": "string", + "tags": [], + "label": "encryptionKey", + "description": [ + "\nA key used to encrypt a cookie's value. Should be at least 32 characters long." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SessionStorageCookieOptions.validate", + "type": "Function", + "tags": [], + "label": "validate", + "description": [ + "\nFunction called to validate a cookie's decrypted value." + ], + "signature": [ + "(sessionValue: T | T[]) => ", + "SessionCookieValidationResult" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SessionStorageCookieOptions.validate.$1", + "type": "CompoundType", + "tags": [], + "label": "sessionValue", + "description": [], + "signature": [ + "T | T[]" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SessionStorageCookieOptions.isSecure", + "type": "boolean", + "tags": [], + "label": "isSecure", + "description": [ + "\nFlag indicating whether the cookie should be sent only via a secure connection." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SessionStorageCookieOptions.sameSite", + "type": "CompoundType", + "tags": [], + "label": "sameSite", + "description": [ + "\nDefines SameSite attribute of the Set-Cookie Header.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite" + ], + "signature": [ + "\"None\" | \"Strict\" | \"Lax\" | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SessionStorageFactory", + "type": "Interface", + "tags": [], + "label": "SessionStorageFactory", + "description": [ + "\nSessionStorage factory to bind one to an incoming request" + ], + "signature": [ + "SessionStorageFactory", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SessionStorageFactory.asScoped", + "type": "Function", + "tags": [], + "label": "asScoped", + "description": [], + "signature": [ + "(request: ", + "KibanaRequest", + ") => ", + "SessionStorage", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SessionStorageFactory.asScoped.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -23138,13 +27790,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "src/core/server/elasticsearch/client/retry_unauthorized.ts", @@ -23361,6 +28007,30 @@ } ], "enums": [ + { + "parentPluginId": "core", + "id": "def-server.AuthResultType", + "type": "Enum", + "tags": [], + "label": "AuthResultType", + "description": [], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.AuthStatus", + "type": "Enum", + "tags": [], + "label": "AuthStatus", + "description": [ + "\nStatus indicating an outcome of the authentication." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "core", "id": "def-server.PluginType", @@ -23530,6 +28200,113 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "core", + "id": "def-server.AuthenticationHandler", + "type": "Type", + "tags": [], + "label": "AuthenticationHandler", + "description": [ + "\nSee {@link AuthToolkit}." + ], + "signature": [ + "(request: ", + "KibanaRequest", + ", response: ", + "LifecycleResponseFactory", + ", toolkit: ", + "AuthToolkit", + ") => ", + "IKibanaResponse", + " | ", + "AuthResult", + " | Promise<", + "IKibanaResponse", + " | ", + "AuthResult", + ">" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.AuthenticationHandler.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.AuthenticationHandler.$2", + "type": "CompoundType", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "KibanaRedirectionResponseFactory", + " & ", + "KibanaErrorResponseFactory" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.AuthenticationHandler.$3", + "type": "Object", + "tags": [], + "label": "toolkit", + "description": [], + "signature": [ + "AuthToolkit" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.AuthHeaders", + "type": "Type", + "tags": [], + "label": "AuthHeaders", + "description": [], + "signature": [ + "{ [x: string]: string | string[]; }" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.AuthResult", + "type": "Type", + "tags": [], + "label": "AuthResult", + "description": [], + "signature": [ + "AuthResultAuthenticated", + " | ", + "AuthResultNotHandled", + " | ", + "AuthResultRedirected" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "core", "id": "def-server.CapabilitiesProvider", @@ -23561,13 +28338,7 @@ ], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ", uiCapabilities: ", "Capabilities", ", useDefaultCapabilities: boolean) => Partial<", @@ -23588,13 +28359,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "src/core/server/capabilities/types.ts", @@ -23820,6 +28585,22 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "core", + "id": "def-server.DestructiveRouteMethod", + "type": "Type", + "tags": [], + "label": "DestructiveRouteMethod", + "description": [ + "\nSet of HTTP methods changing the state of the server." + ], + "signature": [ + "\"delete\" | \"post\" | \"put\" | \"patch\"" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "core", "id": "def-server.DocLinksServiceStart", @@ -23973,7 +28754,7 @@ "label": "EcsEventType", "description": [], "signature": [ - "\"start\" | \"error\" | \"user\" | \"info\" | \"group\" | \"end\" | \"admin\" | \"protocol\" | \"connection\" | \"access\" | \"allowed\" | \"change\" | \"creation\" | \"deletion\" | \"denied\" | \"installation\"" + "\"start\" | \"error\" | \"user\" | \"info\" | \"group\" | \"end\" | \"admin\" | \"protocol\" | \"access\" | \"allowed\" | \"change\" | \"connection\" | \"creation\" | \"deletion\" | \"denied\" | \"installation\"" ], "path": "node_modules/@types/kbn__logging/index.d.ts", "deprecated": false, @@ -25179,457 +29960,787 @@ "default", "; }" ], - "path": "src/core/server/elasticsearch/client/types.ts", + "path": "src/core/server/elasticsearch/client/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchClientConfig", + "type": "Type", + "tags": [], + "label": "ElasticsearchClientConfig", + "description": [ + "\nConfiguration options to be used to create a {@link IClusterClient | cluster client} using the\n{@link ElasticsearchServiceStart.createClient | createClient API}\n" + ], + "signature": [ + "Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchConfig", + "text": "ElasticsearchConfig" + }, + ", \"username\" | \"password\" | \"customHeaders\" | \"hosts\" | \"sniffOnStart\" | \"sniffInterval\" | \"sniffOnConnectionFault\" | \"maxSockets\" | \"compression\" | \"serviceAccountToken\" | \"requestHeadersWhitelist\"> & { pingTimeout?: number | moment.Duration | undefined; requestTimeout?: number | moment.Duration | undefined; ssl?: Partial; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>, \"key\" | \"verificationMode\" | \"certificate\" | \"keyPassphrase\" | \"alwaysPresentCertificate\"> & { certificateAuthorities?: string[] | undefined; }> | undefined; keepAlive?: boolean | undefined; caFingerprint?: string | undefined; }" + ], + "path": "src/core/server/elasticsearch/client/client_config.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.EventType", + "type": "Type", + "tags": [], + "label": "EventType", + "description": [ + "\nEvent Type used for indexed structures. Only used to improve the readability of the types" + ], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ExecutionContextStart", + "type": "Type", + "tags": [], + "label": "ExecutionContextStart", + "description": [], + "signature": [ + "ExecutionContextSetup" + ], + "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ExposedToBrowserDescriptor", + "type": "Type", + "tags": [], + "label": "ExposedToBrowserDescriptor", + "description": [ + "\nType defining the list of configuration properties that will be exposed on the client-side\nObject properties can either be fully exposed\n" + ], + "signature": [ + "{ [Key in keyof T]?: (T[Key] extends Maybe ? boolean : T[Key] extends Maybe ? boolean | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ExposedToBrowserDescriptor", + "text": "ExposedToBrowserDescriptor" + }, + " : boolean) | undefined; }" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.GetAuthHeaders", + "type": "Type", + "tags": [ + "return" + ], + "label": "GetAuthHeaders", + "description": [ + "\nGet headers to authenticate a user against Elasticsearch." + ], + "signature": [ + "(request: ", + "KibanaRequest", + ") => ", + "AuthHeaders", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [ + "authentication headers {@link AuthHeaders } for - an incoming request." + ], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.GetAuthHeaders.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [ + "{@link KibanaRequest } - an incoming request." + ], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.GetAuthState", + "type": "Type", + "tags": [], + "label": "GetAuthState", + "description": [ + "\nGets authentication state for a request. Returned by `auth` interceptor." + ], + "signature": [ + "(request: ", + "KibanaRequest", + ") => { status: ", + "AuthStatus", + "; state: T; }" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.GetAuthState.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [ + "{@link KibanaRequest } - an incoming request." + ], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.HandlerContextType", + "type": "Type", + "tags": [], + "label": "HandlerContextType", + "description": [ + "\nExtracts the type of the first argument of a {@link HandlerFunction} to represent the type of the context.\n" + ], + "signature": [ + "T extends ", + "HandlerFunction", + " ? U : never" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.ElasticsearchClientConfig", + "id": "def-server.HandlerFunction", "type": "Type", "tags": [], - "label": "ElasticsearchClientConfig", + "label": "HandlerFunction", "description": [ - "\nConfiguration options to be used to create a {@link IClusterClient | cluster client} using the\n{@link ElasticsearchServiceStart.createClient | createClient API}\n" + "\nA function that accepts a context object and an optional number of additional arguments. Used for the generic types\nin {@link IContextContainer}\n" ], "signature": [ - "Pick<", + "(context: T, ...args: any[]) => any" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HandlerFunction.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "T" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HandlerFunction.$2", + "type": "Array", + "tags": [], + "label": "args", + "description": [], + "signature": [ + "any[]" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.HandlerParameters", + "type": "Type", + "tags": [], + "label": "HandlerParameters", + "description": [ + "\nExtracts the types of the additional arguments of a {@link HandlerFunction}, excluding the\n{@link HandlerContextType}.\n" + ], + "signature": [ + "T extends (context: any, ...args: infer U) => any ? U : never" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.Headers", + "type": "Type", + "tags": [], + "label": "Headers", + "description": [ + "\nHttp request headers to read." + ], + "signature": [ + "{ warning?: string | string[] | undefined; from?: string | string[] | undefined; date?: string | string[] | undefined; expires?: string | string[] | undefined; range?: string | string[] | undefined; origin?: string | string[] | undefined; location?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; etag?: string | string[] | undefined; authorization?: string | string[] | undefined; connection?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesRequestHandler", + "type": "Type", + "tags": [], + "label": "HttpResourcesRequestHandler", + "description": [ + "\nExtended version of {@link RequestHandler} having access to {@link HttpResourcesServiceToolkit}\nto respond with HTML or JS resources." + ], + "signature": [ + "(context: Context, request: ", + "KibanaRequest", + ", response: ", + "KibanaSuccessResponseFactory", + " & ", + "KibanaRedirectionResponseFactory", + " & ", + "KibanaErrorResponseFactory", + " & { custom | Error | ", + "Stream", + " | Buffer | { message: string | Error; attributes?: ", + "ResponseErrorAttributes", + " | undefined; } | undefined>(options: ", + "CustomHttpResponseOptions", + "): ", + "IKibanaResponse", + "; } & ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchConfig", - "text": "ElasticsearchConfig" + "section": "def-server.HttpResourcesServiceToolkit", + "text": "HttpResourcesServiceToolkit" }, - ", \"username\" | \"password\" | \"customHeaders\" | \"hosts\" | \"sniffOnStart\" | \"sniffInterval\" | \"sniffOnConnectionFault\" | \"maxSockets\" | \"compression\" | \"serviceAccountToken\" | \"requestHeadersWhitelist\"> & { pingTimeout?: number | moment.Duration | undefined; requestTimeout?: number | moment.Duration | undefined; ssl?: Partial; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>, \"key\" | \"verificationMode\" | \"certificate\" | \"keyPassphrase\" | \"alwaysPresentCertificate\"> & { certificateAuthorities?: string[] | undefined; }> | undefined; keepAlive?: boolean | undefined; caFingerprint?: string | undefined; }" + ") => ", + "IKibanaResponse", + " | Promise<", + "IKibanaResponse", + ">" ], - "path": "src/core/server/elasticsearch/client/client_config.ts", + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesRequestHandler.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [ + "{@link RequestHandlerContext } - the core context exposed for this request." + ], + "signature": [ + "Context" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesRequestHandler.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [ + "{@link KibanaRequest } - object containing information about requested resource,\nsuch as path, method, headers, parameters, query, body, etc." + ], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesRequestHandler.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [ + "{@link KibanaResponseFactory } {@libk HttpResourcesServiceToolkit} - a set of helper functions used to respond to a request." + ], + "signature": [ + "ResponseFactory" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesResponseOptions", + "type": "Type", + "tags": [], + "label": "HttpResourcesResponseOptions", + "description": [ + "\nHTTP Resources response parameters" + ], + "signature": [ + "HttpResponseOptions" + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResponsePayload", + "type": "Type", + "tags": [], + "label": "HttpResponsePayload", + "description": [ + "\nData send to the client as a response payload." + ], + "signature": [ + "string | Record | ", + "Stream", + " | Buffer | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.IContextProvider", + "type": "Type", + "tags": [], + "label": "IContextProvider", + "description": [ + "\nA function that returns a context value for a specific key of given context type.\n" + ], + "signature": [ + "(context: Omit, request: ", + "KibanaRequest", + ", response: ", + "KibanaResponseFactory", + ") => ", + "MaybePromise", + ">" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.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.IContextProvider.$1", + "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": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IContextProvider.$2", + "type": "Object", + "tags": [], + "label": "rest", + "description": [ + "- Additional parameters provided by the service owner of this context" + ], + "signature": [ + "[request: ", + "KibanaRequest", + ", response: ", + "KibanaResponseFactory", + "]" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.IsAuthenticated", + "type": "Type", + "tags": [], + "label": "IsAuthenticated", + "description": [ + "\nReturns authentication status for a request." + ], + "signature": [ + "(request: ", + "KibanaRequest", + ") => boolean" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IsAuthenticated.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [ + "{@link KibanaRequest } - an incoming request." + ], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.EventType", + "id": "def-server.KibanaExecutionContext", "type": "Type", "tags": [], - "label": "EventType", - "description": [ - "\nEvent Type used for indexed structures. Only used to improve the readability of the types" - ], + "label": "KibanaExecutionContext", + "description": [], "signature": [ - "string" + "{ readonly type?: string | undefined; readonly name?: string | undefined; readonly page?: string | undefined; readonly id?: string | undefined; readonly description?: string | undefined; readonly url?: string | undefined; child?: ", + "KibanaExecutionContext", + " | undefined; }" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "node_modules/@types/kbn__core-execution-context-common/index.d.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.ExecutionContextStart", + "id": "def-server.KibanaRequestRouteOptions", "type": "Type", "tags": [], - "label": "ExecutionContextStart", - "description": [], + "label": "KibanaRequestRouteOptions", + "description": [ + "\nRoute options: If 'GET' or 'OPTIONS' method, body options won't be returned." + ], "signature": [ - "ExecutionContextSetup" + "Method extends \"options\" | \"get\" ? Required, \"body\">> : Required<", + "RouteConfigOptions", + ">" ], - "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.ExposedToBrowserDescriptor", + "id": "def-server.KibanaResponseFactory", "type": "Type", "tags": [], - "label": "ExposedToBrowserDescriptor", + "label": "KibanaResponseFactory", "description": [ - "\nType defining the list of configuration properties that will be exposed on the client-side\nObject properties can either be fully exposed\n" + "\nSet of helpers used to create `KibanaResponse` to form HTTP response on an incoming request.\nShould be returned as a result of {@link RequestHandler} execution.\n" ], "signature": [ - "{ [Key in keyof T]?: (T[Key] extends Maybe ? boolean : T[Key] extends Maybe ? boolean | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ExposedToBrowserDescriptor", - "text": "ExposedToBrowserDescriptor" - }, - " : boolean) | undefined; }" - ], - "path": "src/core/server/plugins/types.ts", + "KibanaSuccessResponseFactory", + " & ", + "KibanaRedirectionResponseFactory", + " & ", + "KibanaErrorResponseFactory", + " & { custom | Error | ", + "Stream", + " | Buffer | { message: string | Error; attributes?: ", + "ResponseErrorAttributes", + " | undefined; } | undefined>(options: ", + "CustomHttpResponseOptions", + "): ", + "IKibanaResponse", + "; }" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.HandlerContextType", + "id": "def-server.KnownHeaders", "type": "Type", "tags": [], - "label": "HandlerContextType", + "label": "KnownHeaders", "description": [ - "\nExtracts the type of the first argument of a {@link HandlerFunction} to represent the type of the context.\n" + "\nSet of well-known HTTP headers." ], "signature": [ - "T extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.HandlerFunction", - "text": "HandlerFunction" - }, - " ? U : never" + "\"warning\" | \"from\" | \"date\" | \"expires\" | \"range\" | \"origin\" | \"location\" | \"allow\" | \"accept\" | \"host\" | \"etag\" | \"authorization\" | \"connection\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"cache-control\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"expect\" | \"forwarded\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\"" ], - "path": "src/core/server/context/container/context.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.HandlerFunction", + "id": "def-server.LifecycleResponseFactory", "type": "Type", "tags": [], - "label": "HandlerFunction", + "label": "LifecycleResponseFactory", "description": [ - "\nA function that accepts a context object and an optional number of additional arguments. Used for the generic types\nin {@link IContextContainer}\n" + "\nCreates an object containing redirection or error response with error details, HTTP headers, and other data transmitted to the client." ], "signature": [ - "(context: T, ...args: any[]) => any" + "KibanaRedirectionResponseFactory", + " & ", + "KibanaErrorResponseFactory" ], - "path": "src/core/server/context/container/context.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HandlerFunction.$1", - "type": "Uncategorized", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "T" - ], - "path": "src/core/server/context/container/context.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.HandlerFunction.$2", - "type": "Array", - "tags": [], - "label": "args", - "description": [], - "signature": [ - "any[]" - ], - "path": "src/core/server/context/container/context.ts", - "deprecated": false - } - ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.HandlerParameters", + "id": "def-server.LogMeta", "type": "Type", "tags": [], - "label": "HandlerParameters", + "label": "LogMeta", "description": [ - "\nExtracts the types of the additional arguments of a {@link HandlerFunction}, excluding the\n{@link HandlerContextType}.\n" + "\nRepresents the ECS schema with the following reserved keys excluded:\n- `ecs`\n- `@timestamp`\n- `message`\n- `log.level`\n- `log.logger`\n" ], "signature": [ - "T extends (context: any, ...args: infer U) => any ? U : never" + "Omit<", + "EcsBase", + ", \"message\" | \"@timestamp\"> & ", + "EcsTracing", + " & { agent?: ", + "EcsAgent", + " | undefined; as?: ", + "EcsAutonomousSystem", + " | undefined; client?: ", + "EcsClient", + " | undefined; cloud?: ", + "EcsCloud", + " | undefined; container?: ", + "EcsContainer", + " | undefined; destination?: ", + "EcsDestination", + " | undefined; dns?: ", + "EcsDns", + " | undefined; error?: ", + "EcsError", + " | undefined; event?: ", + "EcsEvent", + " | undefined; file?: ", + "EcsFile", + " | undefined; group?: ", + "EcsGroup", + " | undefined; host?: ", + "EcsHost", + " | undefined; http?: ", + "EcsHttp", + " | undefined; log?: Omit<", + "EcsLog", + ", \"logger\" | \"level\"> | undefined; network?: ", + "EcsNetwork", + " | undefined; observer?: ", + "EcsObserver", + " | undefined; organization?: ", + "EcsOrganization", + " | undefined; package?: ", + "EcsPackage", + " | undefined; process?: ", + "EcsProcess", + " | undefined; registry?: ", + "EcsRegistry", + " | undefined; related?: ", + "EcsRelated", + " | undefined; rule?: ", + "EcsRule", + " | undefined; server?: ", + "EcsServer", + " | undefined; service?: ", + "EcsService", + " | undefined; source?: ", + "EcsSource", + " | undefined; threat?: ", + "EcsThreat", + " | undefined; tls?: ", + "EcsTls", + " | undefined; url?: ", + "EcsUrl", + " | undefined; user?: ", + "EcsUser", + " | undefined; user_agent?: ", + "EcsUserAgent", + " | undefined; vulnerability?: ", + "EcsVulnerability", + " | undefined; }" ], - "path": "src/core/server/context/container/context.ts", + "path": "node_modules/@types/kbn__logging/index.d.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.HttpResourcesRequestHandler", + "id": "def-server.MakeUsageFromSchema", "type": "Type", "tags": [], - "label": "HttpResourcesRequestHandler", + "label": "MakeUsageFromSchema", "description": [ - "\nExtended version of {@link RequestHandler} having access to {@link HttpResourcesServiceToolkit}\nto respond with HTML or JS resources." + "\nList of configuration values that will be exposed to usage collection.\nIf parent node or actual config path is set to `true` then the actual value\nof these configs will be reoprted.\nIf parent node or actual config path is set to `false` then the config\nwill be reported as [redacted].\n" ], - "signature": [ - "(context: Context, request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: { custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | 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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", + "signature": [ + "{ [Key in keyof T]?: (T[Key] extends Maybe ? false : T[Key] extends Maybe ? boolean : T[Key] extends Maybe ? boolean | ", { "pluginId": "core", "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" + "docId": "kibCorePluginApi", + "section": "def-server.MakeUsageFromSchema", + "text": "MakeUsageFromSchema" }, - ") => ", - "KibanaResponse", - "; } & ", + " : boolean) | undefined; }" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.MetricsServiceStart", + "type": "Type", + "tags": [], + "label": "MetricsServiceStart", + "description": [ + "\n{@inheritdoc MetricsServiceSetup}\n" + ], + "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.HttpResourcesServiceToolkit", - "text": "HttpResourcesServiceToolkit" - }, + "section": "def-server.MetricsServiceSetup", + "text": "MetricsServiceSetup" + } + ], + "path": "src/core/server/metrics/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.OnPostAuthHandler", + "type": "Type", + "tags": [], + "label": "OnPostAuthHandler", + "description": [ + "\nSee {@link OnPostAuthToolkit}." + ], + "signature": [ + "(request: ", + "KibanaRequest", + ", response: ", + "LifecycleResponseFactory", + ", toolkit: ", + "OnPostAuthToolkit", ") => ", - { - "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" - }, - ">" + "IKibanaResponse", + " | ", + "OnPostAuthNextResult", + " | Promise<", + "IKibanaResponse", + " | ", + "OnPostAuthNextResult", + ">" ], - "path": "src/core/server/http_resources/types.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.HttpResourcesRequestHandler.$1", - "type": "Uncategorized", + "id": "def-server.OnPostAuthHandler.$1", + "type": "Object", "tags": [], - "label": "context", - "description": [ - "{@link RequestHandlerContext } - the core context exposed for this request." - ], + "label": "request", + "description": [], "signature": [ - "Context" + "KibanaRequest", + "" ], - "path": "src/core/server/http/router/router.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.HttpResourcesRequestHandler.$2", - "type": "Object", + "id": "def-server.OnPostAuthHandler.$2", + "type": "CompoundType", "tags": [], - "label": "request", - "description": [ - "{@link KibanaRequest } - object containing information about requested resource,\nsuch as path, method, headers, parameters, query, body, etc." - ], + "label": "response", + "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" + "KibanaRedirectionResponseFactory", + " & ", + "KibanaErrorResponseFactory" ], - "path": "src/core/server/http/router/router.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.HttpResourcesRequestHandler.$3", - "type": "Uncategorized", + "id": "def-server.OnPostAuthHandler.$3", + "type": "Object", "tags": [], - "label": "response", - "description": [ - "{@link KibanaResponseFactory } {@libk HttpResourcesServiceToolkit} - a set of helper functions used to respond to a request." - ], + "label": "toolkit", + "description": [], "signature": [ - "ResponseFactory" + "OnPostAuthToolkit" ], - "path": "src/core/server/http/router/router.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false } ], @@ -25637,462 +30748,418 @@ }, { "parentPluginId": "core", - "id": "def-server.HttpResourcesResponseOptions", + "id": "def-server.OnPreAuthHandler", "type": "Type", "tags": [], - "label": "HttpResourcesResponseOptions", + "label": "OnPreAuthHandler", "description": [ - "\nHTTP Resources response parameters" + "\nSee {@link OnPreAuthToolkit}." ], "signature": [ + "(request: ", + "KibanaRequest", + ", response: ", + "LifecycleResponseFactory", + ", toolkit: ", + "OnPreAuthToolkit", + ") => ", + "IKibanaResponse", + " | ", + "OnPreAuthNextResult", + " | Promise<", + "IKibanaResponse", + " | ", + "OnPreAuthNextResult", + ">" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" + "parentPluginId": "core", + "id": "def-server.OnPreAuthHandler.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.OnPreAuthHandler.$2", + "type": "CompoundType", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "KibanaRedirectionResponseFactory", + " & ", + "KibanaErrorResponseFactory" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.OnPreAuthHandler.$3", + "type": "Object", + "tags": [], + "label": "toolkit", + "description": [], + "signature": [ + "OnPreAuthToolkit" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false } ], - "path": "src/core/server/http_resources/types.ts", - "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.IContextProvider", + "id": "def-server.OnPreResponseHandler", "type": "Type", "tags": [], - "label": "IContextProvider", + "label": "OnPreResponseHandler", "description": [ - "\nA function that returns a context value for a specific key of given context type.\n" + "\nSee {@link OnPreResponseToolkit}." ], "signature": [ - "(context: Omit, request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: { custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | 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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, + "(request: ", + "KibanaRequest", + ", preResponse: ", + "OnPreResponseInfo", + ", toolkit: ", + "OnPreResponseToolkit", ") => ", - "KibanaResponse", - "; notFound: (options?: ", + "OnPreResponseResult", + " | Promise<", + "OnPreResponseResult", + ">" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" + "parentPluginId": "core", + "id": "def-server.OnPreResponseHandler.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, + "parentPluginId": "core", + "id": "def-server.OnPreResponseHandler.$3", + "type": "Object", + "tags": [], + "label": "toolkit", + "description": [], + "signature": [ + "OnPreResponseToolkit" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.OnPreRoutingHandler", + "type": "Type", + "tags": [], + "label": "OnPreRoutingHandler", + "description": [ + "\nSee {@link OnPreRoutingToolkit}." + ], + "signature": [ + "(request: ", + "KibanaRequest", + ", response: ", + "LifecycleResponseFactory", + ", toolkit: ", + "OnPreRoutingToolkit", ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", + "IKibanaResponse", + " | ", + "OnPreRoutingResult", + " | Promise<", + "IKibanaResponse", + " | ", + "OnPreRoutingResult", + ">" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" + "parentPluginId": "core", + "id": "def-server.OnPreRoutingHandler.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", + { + "parentPluginId": "core", + "id": "def-server.OnPreRoutingHandler.$3", + "type": "Object", + "tags": [], + "label": "toolkit", + "description": [], + "signature": [ + "OnPreRoutingToolkit" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.PluginConfigSchema", + "type": "Type", + "tags": [], + "label": "PluginConfigSchema", + "description": [ + "\nDedicated type for plugin configuration schema.\n" + ], + "signature": [ + "Type", + "" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.PluginInitializer", + "type": "Type", + "tags": [], + "label": "PluginInitializer", + "description": [ + "\nThe `plugin` export at the root of a plugin's `server` directory should conform\nto this interface.\n" + ], + "signature": [ + "(core: ", { "pluginId": "core", "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" + "docId": "kibCorePluginApi", + "section": "def-server.PluginInitializerContext", + "text": "PluginInitializerContext" }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", + ") => ", { "pluginId": "core", "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" + "docId": "kibCorePluginApi", + "section": "def-server.Plugin", + "text": "Plugin" }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", + " | ", { "pluginId": "core", "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" + "docId": "kibCorePluginApi", + "section": "def-server.PrebootPlugin", + "text": "PrebootPlugin" }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", + " | ", { "pluginId": "core", "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" + "docId": "kibCorePluginApi", + "section": "def-server.AsyncPlugin", + "text": "AsyncPlugin" }, - ") => ", - "KibanaResponse", - "; }) => ", - "MaybePromise", - ">" + "" ], - "path": "src/core/server/context/container/context.ts", + "path": "src/core/server/plugins/types.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." - ], + "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.IContextProvider.$1", - "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.IContextProvider.$2", + "id": "def-server.PluginInitializer.$1", "type": "Object", "tags": [], - "label": "rest", - "description": [ - "- Additional parameters provided by the service owner of this context" - ], + "label": "core", + "description": [], "signature": [ - "[request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: { custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | 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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" + "docId": "kibCorePluginApi", + "section": "def-server.PluginInitializerContext", + "text": "PluginInitializerContext" }, - ") => ", - "KibanaResponse", - "; }]" + "" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.PluginName", + "type": "Type", + "tags": [], + "label": "PluginName", + "description": [ + "\nDedicated type for plugin name/id that is supposed to make Map/Set/Arrays\nthat use it as a key or value more obvious.\n" + ], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-base-common/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.PluginOpaqueId", + "type": "Type", + "tags": [], + "label": "PluginOpaqueId", + "description": [], + "signature": [ + "symbol" + ], + "path": "node_modules/@types/kbn__core-base-common/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.PublicHttpServiceSetup", + "type": "Type", + "tags": [], + "label": "PublicHttpServiceSetup", + "description": [ + "\nPublic version of RequestHandlerContext, default-scoped to {@link RequestHandlerContext}\nSee [@link RequestHandlerContext}" + ], + "signature": [ + "HttpServiceSetup", + "" + ], + "path": "src/core/server/index.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.PublicRequestHandler", + "type": "Type", + "tags": [], + "label": "PublicRequestHandler", + "description": [ + "\nPublic version of RequestHandler, default-scoped to {@link RequestHandlerContext}\nSee [@link RequestHandler}" + ], + "signature": [ + "(context: Context, request: ", + "KibanaRequest", + ", response: ResponseFactory) => ", + "IKibanaResponse", + " | Promise<", + "IKibanaResponse", + ">" + ], + "path": "src/core/server/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.PublicRequestHandler.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.PublicRequestHandler.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.PublicRequestHandler.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" ], - "path": "src/core/server/context/container/context.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false } ], @@ -26100,373 +31167,455 @@ }, { "parentPluginId": "core", - "id": "def-server.KibanaExecutionContext", + "id": "def-server.PublicRouter", "type": "Type", "tags": [], - "label": "KibanaExecutionContext", - "description": [], + "label": "PublicRouter", + "description": [ + "\nPublic version of IRouter, default-scoped to {@link RequestHandlerContext}\nSee [@link IRouter}" + ], "signature": [ - "{ readonly type?: string | undefined; readonly name?: string | undefined; readonly page?: string | undefined; readonly id?: string | undefined; readonly description?: string | undefined; readonly url?: string | undefined; child?: ", - "KibanaExecutionContext", - " | undefined; }" + "IRouter", + "" ], - "path": "node_modules/@types/kbn__core-execution-context-common/index.d.ts", + "path": "src/core/server/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.LogMeta", + "id": "def-server.PublicUiSettingsParams", "type": "Type", "tags": [], - "label": "LogMeta", + "label": "PublicUiSettingsParams", "description": [ - "\nRepresents the ECS schema with the following reserved keys excluded:\n- `ecs`\n- `@timestamp`\n- `message`\n- `log.level`\n- `log.logger`\n" + "\nA sub-set of {@link UiSettingsParams} exposed to the client-side." ], "signature": [ - "Omit<", - "EcsBase", - ", \"message\" | \"@timestamp\"> & ", - "EcsTracing", - " & { agent?: ", - "EcsAgent", - " | undefined; as?: ", - "EcsAutonomousSystem", - " | undefined; client?: ", - "EcsClient", - " | undefined; cloud?: ", - "EcsCloud", - " | undefined; container?: ", - "EcsContainer", - " | undefined; destination?: ", - "EcsDestination", - " | undefined; dns?: ", - "EcsDns", - " | undefined; error?: ", - "EcsError", - " | undefined; event?: ", - "EcsEvent", - " | undefined; file?: ", - "EcsFile", - " | undefined; group?: ", - "EcsGroup", - " | undefined; host?: ", - "EcsHost", - " | undefined; http?: ", - "EcsHttp", - " | undefined; log?: Omit<", - "EcsLog", - ", \"logger\" | \"level\"> | undefined; network?: ", - "EcsNetwork", - " | undefined; observer?: ", - "EcsObserver", - " | undefined; organization?: ", - "EcsOrganization", - " | undefined; package?: ", - "EcsPackage", - " | undefined; process?: ", - "EcsProcess", - " | undefined; registry?: ", - "EcsRegistry", - " | undefined; related?: ", - "EcsRelated", - " | undefined; rule?: ", - "EcsRule", - " | undefined; server?: ", - "EcsServer", - " | undefined; service?: ", - "EcsService", - " | undefined; source?: ", - "EcsSource", - " | undefined; threat?: ", - "EcsThreat", - " | undefined; tls?: ", - "EcsTls", - " | undefined; url?: ", - "EcsUrl", - " | undefined; user?: ", - "EcsUser", - " | undefined; user_agent?: ", - "EcsUserAgent", - " | undefined; vulnerability?: ", - "EcsVulnerability", + "{ metric?: { type: string; name: string; } | undefined; type?: ", + "UiSettingsType", + " | undefined; value?: unknown; description?: string | undefined; name?: string | undefined; options?: string[] | undefined; order?: number | undefined; category?: string[] | undefined; optionLabels?: Record | undefined; requiresPageReload?: boolean | undefined; readonly?: boolean | undefined; sensitive?: boolean | undefined; deprecation?: ", + "DeprecationSettings", " | undefined; }" ], - "path": "node_modules/@types/kbn__logging/index.d.ts", + "path": "src/core/types/ui_settings.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.MakeUsageFromSchema", + "id": "def-server.RedirectResponseOptions", "type": "Type", "tags": [], - "label": "MakeUsageFromSchema", + "label": "RedirectResponseOptions", "description": [ - "\nList of configuration values that will be exposed to usage collection.\nIf parent node or actual config path is set to `true` then the actual value\nof these configs will be reoprted.\nIf parent node or actual config path is set to `false` then the config\nwill be reported as [redacted].\n" + "\nHTTP response parameters for redirection response" ], "signature": [ - "{ [Key in keyof T]?: (T[Key] extends Maybe ? false : T[Key] extends Maybe ? boolean : T[Key] extends Maybe ? boolean | ", + "HttpResponseOptions", + " & { headers: { location: string; }; }" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.RequestHandler", + "type": "Type", + "tags": [], + "label": "RequestHandler", + "description": [ + "\nA function executed when route path matched requested resource path.\nRequest handler is expected to return a result of one of {@link KibanaResponseFactory} functions.\nIf anything else is returned, or an error is thrown, the HTTP service will automatically log the error\nand respond `500 - Internal Server Error`." + ], + "signature": [ + "(context: Context, request: ", + "KibanaRequest", + ", response: ResponseFactory) => ", + "IKibanaResponse", + " | Promise<", + "IKibanaResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.MakeUsageFromSchema", - "text": "MakeUsageFromSchema" + "parentPluginId": "core", + "id": "def-server.RequestHandler.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [ + "{@link RequestHandlerContext } - the core context exposed for this request." + ], + "signature": [ + "Context" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false }, - " : boolean) | undefined; }" + { + "parentPluginId": "core", + "id": "def-server.RequestHandler.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [ + "{@link KibanaRequest } - object containing information about requested resource,\nsuch as path, method, headers, parameters, query, body, etc." + ], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RequestHandler.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [ + "{@link KibanaResponseFactory } - a set of helper functions used to respond to a request." + ], + "signature": [ + "ResponseFactory" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.RequestHandlerWrapper", + "type": "Type", + "tags": [], + "label": "RequestHandlerWrapper", + "description": [ + "\nType-safe wrapper for {@link RequestHandler} function." + ], + "signature": [ + "(handler: ", + "RequestHandler", + ") => ", + "RequestHandler", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.RequestHandlerWrapper.$1", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ + "(context: Context, request: ", + "KibanaRequest", + ", response: ResponseFactory) => ", + "IKibanaResponse", + " | Promise<", + "IKibanaResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.RequestHandlerWrapper.$1.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RequestHandlerWrapper.$1.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RequestHandlerWrapper.$1.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ] + } ], - "path": "src/core/server/plugins/types.ts", - "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.MetricsServiceStart", + "id": "def-server.ResponseError", "type": "Type", "tags": [], - "label": "MetricsServiceStart", + "label": "ResponseError", "description": [ - "\n{@inheritdoc MetricsServiceSetup}\n" + "\nError message and optional data send to the client in case of error." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.MetricsServiceSetup", - "text": "MetricsServiceSetup" - } + "string | Error | { message: string | Error; attributes?: ", + "ResponseErrorAttributes", + " | undefined; }" ], - "path": "src/core/server/metrics/types.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.PluginConfigSchema", + "id": "def-server.ResponseErrorAttributes", "type": "Type", "tags": [], - "label": "PluginConfigSchema", + "label": "ResponseErrorAttributes", "description": [ - "\nDedicated type for plugin configuration schema.\n" + "\nAdditional data to provide error details." ], "signature": [ - "Type", - "" + "{ [x: string]: any; }" ], - "path": "src/core/server/plugins/types.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.PluginInitializer", + "id": "def-server.ResponseHeaders", "type": "Type", "tags": [], - "label": "PluginInitializer", + "label": "ResponseHeaders", "description": [ - "\nThe `plugin` export at the root of a plugin's `server` directory should conform\nto this interface.\n" + "\nHttp response headers to set." ], "signature": [ - "(core: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.PluginInitializerContext", - "text": "PluginInitializerContext" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.Plugin", - "text": "Plugin" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.PrebootPlugin", - "text": "PrebootPlugin" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.AsyncPlugin", - "text": "AsyncPlugin" - }, - "" + "Record<\"warning\" | \"from\" | \"date\" | \"expires\" | \"range\" | \"origin\" | \"location\" | \"allow\" | \"accept\" | \"host\" | \"etag\" | \"authorization\" | \"connection\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"cache-control\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"expect\" | \"forwarded\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]> | Record" ], - "path": "src/core/server/plugins/types.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.PluginInitializer.$1", - "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 }, { "parentPluginId": "core", - "id": "def-server.PluginName", + "id": "def-server.RouteContentType", "type": "Type", "tags": [], - "label": "PluginName", + "label": "RouteContentType", "description": [ - "\nDedicated type for plugin name/id that is supposed to make Map/Set/Arrays\nthat use it as a key or value more obvious.\n" + "\nThe set of supported parseable Content-Types" ], "signature": [ - "string" + "\"application/json\" | \"multipart/form-data\" | \"application/*+json\" | \"application/octet-stream\" | \"application/x-www-form-urlencoded\" | \"text/*\"" ], - "path": "node_modules/@types/kbn__core-base-common/index.d.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.PluginOpaqueId", + "id": "def-server.RouteMethod", "type": "Type", "tags": [], - "label": "PluginOpaqueId", - "description": [], + "label": "RouteMethod", + "description": [ + "\nThe set of common HTTP methods supported by Kibana routing." + ], "signature": [ - "symbol" + "SafeRouteMethod", + " | ", + "DestructiveRouteMethod" ], - "path": "node_modules/@types/kbn__core-base-common/index.d.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.PublicHttpServiceSetup", + "id": "def-server.RouteRegistrar", "type": "Type", "tags": [], - "label": "PublicHttpServiceSetup", + "label": "RouteRegistrar", "description": [ - "\nPublic version of RequestHandlerContext, default-scoped to {@link RequestHandlerContext}\nSee [@link RequestHandlerContext}" + "\nRoute handler common definition\n" ], "signature": [ + "(route: ", + "RouteConfig", + ", handler: ", + "RequestHandler", + ") => void" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpServiceSetup", - "text": "HttpServiceSetup" + "parentPluginId": "core", + "id": "def-server.RouteRegistrar.$1", + "type": "Object", + "tags": [], + "label": "route", + "description": [], + "signature": [ + "RouteConfig", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false }, - "" + { + "parentPluginId": "core", + "id": "def-server.RouteRegistrar.$2", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ + "(context: Context, request: ", + "KibanaRequest", + ", response: ", + "KibanaResponseFactory", + ") => ", + "IKibanaResponse", + " | Promise<", + "IKibanaResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.RouteRegistrar.$2.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteRegistrar.$2.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteRegistrar.$2.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ] + } ], - "path": "src/core/server/index.ts", - "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.PublicRequestHandler", + "id": "def-server.RouteValidationFunction", "type": "Type", "tags": [], - "label": "PublicRequestHandler", + "label": "RouteValidationFunction", "description": [ - "\nPublic version of RequestHandler, default-scoped to {@link RequestHandlerContext}\nSee [@link RequestHandler}" + "\nThe custom validation function if @kbn/config-schema is not a valid solution for your specific plugin requirements.\n" ], "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" - }, - ">" + "(data: any, validationResult: ", + "RouteValidationResultFactory", + ") => { value: T; error?: undefined; } | { value?: undefined; error: ", + "RouteValidationError", + "; }" ], - "path": "src/core/server/index.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.PublicRequestHandler.$1", - "type": "Uncategorized", + "id": "def-server.RouteValidationFunction.$1", + "type": "Any", "tags": [], - "label": "context", + "label": "data", "description": [], "signature": [ - "Context" + "any" ], - "path": "src/core/server/http/router/router.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.PublicRequestHandler.$2", + "id": "def-server.RouteValidationFunction.$2", "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.PublicRequestHandler.$3", - "type": "Uncategorized", - "tags": [], - "label": "response", + "label": "validationResult", "description": [], "signature": [ - "ResponseFactory" + "RouteValidationResultFactory" ], - "path": "src/core/server/http/router/router.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false } ], @@ -26474,44 +31623,56 @@ }, { "parentPluginId": "core", - "id": "def-server.PublicRouter", + "id": "def-server.RouteValidationSpec", "type": "Type", "tags": [], - "label": "PublicRouter", + "label": "RouteValidationSpec", "description": [ - "\nPublic version of IRouter, default-scoped to {@link RequestHandlerContext}\nSee [@link IRouter}" + "\nAllowed property validation options: either @kbn/config-schema validations or custom validation functions\n\nSee {@link RouteValidationFunction} for custom validation.\n" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IRouter", - "text": "IRouter" - }, - "" + "ObjectType", + " | ", + "Type", + " | ", + "RouteValidationFunction", + "" ], - "path": "src/core/server/index.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.PublicUiSettingsParams", + "id": "def-server.RouteValidatorFullConfig", "type": "Type", "tags": [], - "label": "PublicUiSettingsParams", + "label": "RouteValidatorFullConfig", "description": [ - "\nA sub-set of {@link UiSettingsParams} exposed to the client-side." + "\nRoute validations config and options merged into one object" ], "signature": [ - "{ metric?: { type: string; name: string; } | undefined; type?: ", - "UiSettingsType", - " | undefined; value?: unknown; description?: string | undefined; name?: string | undefined; options?: string[] | undefined; order?: number | undefined; category?: string[] | undefined; optionLabels?: Record | undefined; requiresPageReload?: boolean | undefined; readonly?: boolean | undefined; sensitive?: boolean | undefined; deprecation?: ", - "DeprecationSettings", - " | undefined; }" + "RouteValidatorConfig", + " & ", + "RouteValidatorOptions" ], - "path": "src/core/types/ui_settings.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SafeRouteMethod", + "type": "Type", + "tags": [], + "label": "SafeRouteMethod", + "description": [ + "\nSet of HTTP methods not changing the state of the server." + ], + "signature": [ + "\"options\" | \"get\"" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "initialIsOpen": false }, @@ -26570,13 +31731,7 @@ "text": "FakeRequest" }, " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "src/core/server/elasticsearch/types.ts", @@ -26805,6 +31960,22 @@ "path": "src/core/server/status/types.ts", "deprecated": false, "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.validBodyOutput", + "type": "Object", + "tags": [], + "label": "validBodyOutput", + "description": [ + "\nThe set of valid body.output" + ], + "signature": [ + "readonly [\"data\", \"stream\"]" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "initialIsOpen": false } ] }, diff --git a/api_docs/core.mdx b/api_docs/core.mdx index 1418ea0688c29..1ca2a7bd7646b 100644 --- a/api_docs/core.mdx +++ b/api_docs/core.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core title: "core" image: https://source.unsplash.com/400x175/?github summary: API docs for the core plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2506 | 14 | 887 | 27 | +| 2489 | 9 | 746 | 25 | ## Client diff --git a/api_docs/core_application.mdx b/api_docs/core_application.mdx index e72fcd7445f91..73e1cc4df37c8 100644 --- a/api_docs/core_application.mdx +++ b/api_docs/core_application.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-application title: "core.application" image: https://source.unsplash.com/400x175/?github summary: API docs for the core.application plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.application'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2506 | 14 | 887 | 27 | +| 2489 | 9 | 746 | 25 | ## Client diff --git a/api_docs/core_chrome.mdx b/api_docs/core_chrome.mdx index dbc886414e9ce..38935d4adbf2c 100644 --- a/api_docs/core_chrome.mdx +++ b/api_docs/core_chrome.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-chrome title: "core.chrome" image: https://source.unsplash.com/400x175/?github summary: API docs for the core.chrome plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.chrome'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2506 | 14 | 887 | 27 | +| 2489 | 9 | 746 | 25 | ## Client diff --git a/api_docs/core_http.devdocs.json b/api_docs/core_http.devdocs.json index 1eb2780206d34..3aea850ad213e 100644 --- a/api_docs/core_http.devdocs.json +++ b/api_docs/core_http.devdocs.json @@ -3,13175 +3,116 @@ "client": { "classes": [], "functions": [], - "interfaces": [ - { - "parentPluginId": "core", - "id": "def-public.HttpFetchOptions", - "type": "Interface", - "tags": [], - "label": "HttpFetchOptions", - "description": [ - "\nAll options that may be used with a {@link HttpHandler}." - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpFetchOptions", - "text": "HttpFetchOptions" - }, - " extends ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpRequestInit", - "text": "HttpRequestInit" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.HttpFetchOptions.query", - "type": "Object", - "tags": [], - "label": "query", - "description": [ - "\nThe query string for an HTTP request. See {@link HttpFetchQuery}." - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpFetchQuery", - "text": "HttpFetchQuery" - }, - " | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpFetchOptions.prependBasePath", - "type": "CompoundType", - "tags": [], - "label": "prependBasePath", - "description": [ - "\nWhether or not the request should automatically prepend the basePath. Defaults to `true`." - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpFetchOptions.headers", - "type": "Object", - "tags": [], - "label": "headers", - "description": [ - "\nHeaders to send with the request. See {@link HttpHeadersInit}." - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpHeadersInit", - "text": "HttpHeadersInit" - }, - " | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpFetchOptions.asSystemRequest", - "type": "CompoundType", - "tags": [], - "label": "asSystemRequest", - "description": [ - "\nWhether or not the request should include the \"system request\" header to differentiate an end user request from\nKibana internal request.\nCan be read on the server-side using KibanaRequest#isSystemRequest. Defaults to `false`." - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpFetchOptions.asResponse", - "type": "CompoundType", - "tags": [], - "label": "asResponse", - "description": [ - "\nWhen `true` the return type of {@link HttpHandler} will be an {@link HttpResponse} with detailed request and\nresponse information. When `false`, the return type will just be the parsed response body. Defaults to `false`." - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpFetchOptions.context", - "type": "Object", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "KibanaExecutionContext", - " | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpFetchOptionsWithPath", - "type": "Interface", - "tags": [], - "label": "HttpFetchOptionsWithPath", - "description": [ - "\nSimilar to {@link HttpFetchOptions} but with the URL path included." - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpFetchOptionsWithPath", - "text": "HttpFetchOptionsWithPath" - }, - " extends ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpFetchOptions", - "text": "HttpFetchOptions" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.HttpFetchOptionsWithPath.path", - "type": "string", - "tags": [], - "label": "path", - "description": [], - "path": "src/core/public/http/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpFetchQuery", - "type": "Interface", - "tags": [], - "label": "HttpFetchQuery", - "description": [], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.HttpFetchQuery.Unnamed", - "type": "IndexSignature", - "tags": [], - "label": "[key: string]: string | number | boolean | string[] | number[] | boolean[] | null | undefined", - "description": [ - "\nTypeScript note: Technically we should use this interface instead, but @types/node uses the below stricter\ndefinition, so to avoid TypeScript errors, we'll restrict our version.\n\n[key: string]:\n | string\n | number\n | boolean\n | Array\n | undefined\n | null;" - ], - "signature": [ - "[key: string]: string | number | boolean | string[] | number[] | boolean[] | null | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpHandler", - "type": "Interface", - "tags": [], - "label": "HttpHandler", - "description": [ - "\nA function for making an HTTP requests to Kibana's backend. See {@link HttpFetchOptions} for options and\n{@link HttpResponse} for the response.\n" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.HttpHandler.Unnamed", - "type": "Any", - "tags": [], - "label": "Unnamed", - "description": [], - "signature": [ - "any" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpHandler.Unnamed", - "type": "Any", - "tags": [], - "label": "Unnamed", - "description": [], - "signature": [ - "any" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpHandler.Unnamed", - "type": "Any", - "tags": [], - "label": "Unnamed", - "description": [], - "signature": [ - "any" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpHandler.Unnamed", - "type": "Any", - "tags": [], - "label": "Unnamed", - "description": [], - "signature": [ - "any" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpHeadersInit", - "type": "Interface", - "tags": [], - "label": "HttpHeadersInit", - "description": [ - "\nHeaders to append to the request. Any headers that begin with `kbn-` are considered private to Core and will cause\n{@link HttpHandler} to throw an error." - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.HttpHeadersInit.Unnamed", - "type": "IndexSignature", - "tags": [], - "label": "[name: string]: any", - "description": [], - "signature": [ - "[name: string]: any" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptor", - "type": "Interface", - "tags": [], - "label": "HttpInterceptor", - "description": [ - "\nAn object that may define global interceptor functions for different parts of the request and response lifecycle.\nSee {@link IHttpInterceptController}.\n" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptor.request", - "type": "Function", - "tags": [], - "label": "request", - "description": [ - "\nDefine an interceptor to be executed before a request is sent." - ], - "signature": [ - "((fetchOptions: Readonly<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpFetchOptionsWithPath", - "text": "HttpFetchOptionsWithPath" - }, - ">, controller: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IHttpInterceptController", - "text": "IHttpInterceptController" - }, - ") => void | ", - "MaybePromise", - ">) | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptor.request.$1", - "type": "Object", - "tags": [], - "label": "fetchOptions", - "description": [], - "signature": [ - "Readonly<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpFetchOptionsWithPath", - "text": "HttpFetchOptionsWithPath" - }, - ">" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptor.request.$2", - "type": "Object", - "tags": [], - "label": "controller", - "description": [ - "{@link IHttpInterceptController }" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IHttpInterceptController", - "text": "IHttpInterceptController" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptor.requestError", - "type": "Function", - "tags": [], - "label": "requestError", - "description": [ - "\nDefine an interceptor to be executed if a request interceptor throws an error or returns a rejected Promise." - ], - "signature": [ - "((httpErrorRequest: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpInterceptorRequestError", - "text": "HttpInterceptorRequestError" - }, - ", controller: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IHttpInterceptController", - "text": "IHttpInterceptController" - }, - ") => void | ", - "MaybePromise", - ">) | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptor.requestError.$1", - "type": "Object", - "tags": [], - "label": "httpErrorRequest", - "description": [ - "{@link HttpInterceptorRequestError }" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpInterceptorRequestError", - "text": "HttpInterceptorRequestError" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptor.requestError.$2", - "type": "Object", - "tags": [], - "label": "controller", - "description": [ - "{@link IHttpInterceptController }" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IHttpInterceptController", - "text": "IHttpInterceptController" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptor.response", - "type": "Function", - "tags": [], - "label": "response", - "description": [ - "\nDefine an interceptor to be executed after a response is received." - ], - "signature": [ - "((httpResponse: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpResponse", - "text": "HttpResponse" - }, - ", controller: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IHttpInterceptController", - "text": "IHttpInterceptController" - }, - ") => void | ", - "MaybePromise", - "<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IHttpResponseInterceptorOverrides", - "text": "IHttpResponseInterceptorOverrides" - }, - ">) | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptor.response.$1", - "type": "Object", - "tags": [], - "label": "httpResponse", - "description": [ - "{@link HttpResponse }" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpResponse", - "text": "HttpResponse" - }, - "" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptor.response.$2", - "type": "Object", - "tags": [], - "label": "controller", - "description": [ - "{@link IHttpInterceptController }" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IHttpInterceptController", - "text": "IHttpInterceptController" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptor.responseError", - "type": "Function", - "tags": [], - "label": "responseError", - "description": [ - "\nDefine an interceptor to be executed if a response interceptor throws an error or returns a rejected Promise." - ], - "signature": [ - "((httpErrorResponse: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpInterceptorResponseError", - "text": "HttpInterceptorResponseError" - }, - ", controller: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IHttpInterceptController", - "text": "IHttpInterceptController" - }, - ") => void | ", - "MaybePromise", - "<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IHttpResponseInterceptorOverrides", - "text": "IHttpResponseInterceptorOverrides" - }, - ">) | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptor.responseError.$1", - "type": "Object", - "tags": [], - "label": "httpErrorResponse", - "description": [ - "{@link HttpInterceptorResponseError }" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpInterceptorResponseError", - "text": "HttpInterceptorResponseError" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptor.responseError.$2", - "type": "Object", - "tags": [], - "label": "controller", - "description": [ - "{@link IHttpInterceptController }" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IHttpInterceptController", - "text": "IHttpInterceptController" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptorRequestError", - "type": "Interface", - "tags": [], - "label": "HttpInterceptorRequestError", - "description": [], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptorRequestError.fetchOptions", - "type": "Object", - "tags": [], - "label": "fetchOptions", - "description": [], - "signature": [ - "{ readonly path: string; readonly query?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpFetchQuery", - "text": "HttpFetchQuery" - }, - " | undefined; readonly prependBasePath?: boolean | undefined; readonly headers?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpHeadersInit", - "text": "HttpHeadersInit" - }, - " | undefined; readonly asSystemRequest?: boolean | undefined; readonly asResponse?: boolean | undefined; readonly context?: ", - "KibanaExecutionContext", - " | undefined; readonly body?: BodyInit | null | undefined; readonly cache?: RequestCache | undefined; readonly credentials?: RequestCredentials | undefined; readonly integrity?: string | undefined; readonly keepalive?: boolean | undefined; readonly method?: string | undefined; readonly mode?: RequestMode | undefined; readonly redirect?: RequestRedirect | undefined; readonly referrer?: string | undefined; readonly referrerPolicy?: ReferrerPolicy | undefined; readonly signal?: AbortSignal | null | undefined; readonly window?: null | undefined; }" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptorRequestError.error", - "type": "Object", - "tags": [], - "label": "error", - "description": [], - "signature": [ - "Error" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptorResponseError", - "type": "Interface", - "tags": [], - "label": "HttpInterceptorResponseError", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpInterceptorResponseError", - "text": "HttpInterceptorResponseError" - }, - " extends ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpResponse", - "text": "HttpResponse" - }, - "" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptorResponseError.request", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - "{ readonly cache: RequestCache; readonly credentials: RequestCredentials; readonly destination: RequestDestination; readonly headers: Headers; readonly integrity: string; readonly keepalive: boolean; readonly method: string; readonly mode: RequestMode; readonly redirect: RequestRedirect; readonly referrer: string; readonly referrerPolicy: ReferrerPolicy; readonly signal: AbortSignal; readonly url: string; readonly clone: () => Request; readonly body: ReadableStream | null; readonly bodyUsed: boolean; readonly arrayBuffer: () => Promise; readonly blob: () => Promise; readonly formData: () => Promise; readonly json: () => Promise; readonly text: () => Promise; }" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptorResponseError.error", - "type": "CompoundType", - "tags": [], - "label": "error", - "description": [], - "signature": [ - "Error | ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IHttpFetchError", - "text": "IHttpFetchError" - }, - "" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpRequestInit", - "type": "Interface", - "tags": [], - "label": "HttpRequestInit", - "description": [ - "\nFetch API options available to {@link HttpHandler}s.\n" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.HttpRequestInit.body", - "type": "CompoundType", - "tags": [], - "label": "body", - "description": [ - "\nA BodyInit object or null to set request's body." - ], - "signature": [ - "BodyInit | null | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpRequestInit.cache", - "type": "CompoundType", - "tags": [], - "label": "cache", - "description": [ - "\nThe cache mode associated with request, which is a string indicating how the request will interact with the\nbrowser's cache when fetching." - ], - "signature": [ - "RequestCache | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpRequestInit.credentials", - "type": "CompoundType", - "tags": [], - "label": "credentials", - "description": [ - "\nThe credentials mode associated with request, which is a string indicating whether credentials will be sent with\nthe request always, never, or only when sent to a same-origin URL." - ], - "signature": [ - "RequestCredentials | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpRequestInit.headers", - "type": "Object", - "tags": [], - "label": "headers", - "description": [ - "{@link HttpHeadersInit}" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpHeadersInit", - "text": "HttpHeadersInit" - }, - " | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpRequestInit.integrity", - "type": "string", - "tags": [], - "label": "integrity", - "description": [ - "\nSubresource integrity metadata, which is a cryptographic hash of the resource being fetched. Its value consists of\nmultiple hashes separated by whitespace." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpRequestInit.keepalive", - "type": "CompoundType", - "tags": [], - "label": "keepalive", - "description": [ - "Whether or not request can outlive the global in which it was created." - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpRequestInit.method", - "type": "string", - "tags": [], - "label": "method", - "description": [ - "HTTP method, which is \"GET\" by default." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpRequestInit.mode", - "type": "CompoundType", - "tags": [], - "label": "mode", - "description": [ - "\nThe mode associated with request, which is a string indicating whether the request will use CORS, or will be\nrestricted to same-origin URLs." - ], - "signature": [ - "RequestMode | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpRequestInit.redirect", - "type": "CompoundType", - "tags": [], - "label": "redirect", - "description": [ - "\nThe redirect mode associated with request, which is a string indicating how redirects for the request will be\nhandled during fetching. A request will follow redirects by default." - ], - "signature": [ - "RequestRedirect | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpRequestInit.referrer", - "type": "string", - "tags": [], - "label": "referrer", - "description": [ - "\nThe referrer of request. Its value can be a same-origin URL if explicitly set in init, the empty string to\nindicate no referrer, and \"about:client\" when defaulting to the global's default. This is used during fetching to\ndetermine the value of the `Referer` header of the request being made." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpRequestInit.referrerPolicy", - "type": "CompoundType", - "tags": [], - "label": "referrerPolicy", - "description": [ - "\nThe referrer policy associated with request. This is used during fetching to compute the value of the request's\nreferrer." - ], - "signature": [ - "ReferrerPolicy | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpRequestInit.signal", - "type": "CompoundType", - "tags": [], - "label": "signal", - "description": [ - "\nReturns the signal associated with request, which is an AbortSignal object indicating whether or not request has\nbeen aborted, and its abort event handler." - ], - "signature": [ - "AbortSignal | null | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpRequestInit.window", - "type": "Uncategorized", - "tags": [], - "label": "window", - "description": [ - "\nCan only be null. Used to disassociate request from any Window." - ], - "signature": [ - "null | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpResponse", - "type": "Interface", - "tags": [], - "label": "HttpResponse", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpResponse", - "text": "HttpResponse" - }, - "" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.HttpResponse.fetchOptions", - "type": "Object", - "tags": [], - "label": "fetchOptions", - "description": [ - "The original {@link HttpFetchOptionsWithPath} used to send this request." - ], - "signature": [ - "{ readonly path: string; readonly query?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpFetchQuery", - "text": "HttpFetchQuery" - }, - " | undefined; readonly prependBasePath?: boolean | undefined; readonly headers?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpHeadersInit", - "text": "HttpHeadersInit" - }, - " | undefined; readonly asSystemRequest?: boolean | undefined; readonly asResponse?: boolean | undefined; readonly context?: ", - "KibanaExecutionContext", - " | undefined; readonly body?: BodyInit | null | undefined; readonly cache?: RequestCache | undefined; readonly credentials?: RequestCredentials | undefined; readonly integrity?: string | undefined; readonly keepalive?: boolean | undefined; readonly method?: string | undefined; readonly mode?: RequestMode | undefined; readonly redirect?: RequestRedirect | undefined; readonly referrer?: string | undefined; readonly referrerPolicy?: ReferrerPolicy | undefined; readonly signal?: AbortSignal | null | undefined; readonly window?: null | undefined; }" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpResponse.request", - "type": "Object", - "tags": [], - "label": "request", - "description": [ - "Raw request sent to Kibana server." - ], - "signature": [ - "{ readonly cache: RequestCache; readonly credentials: RequestCredentials; readonly destination: RequestDestination; readonly headers: Headers; readonly integrity: string; readonly keepalive: boolean; readonly method: string; readonly mode: RequestMode; readonly redirect: RequestRedirect; readonly referrer: string; readonly referrerPolicy: ReferrerPolicy; readonly signal: AbortSignal; readonly url: string; readonly clone: () => Request; readonly body: ReadableStream | null; readonly bodyUsed: boolean; readonly arrayBuffer: () => Promise; readonly blob: () => Promise; readonly formData: () => Promise; readonly json: () => Promise; readonly text: () => Promise; }" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpResponse.response", - "type": "Object", - "tags": [], - "label": "response", - "description": [ - "Raw response received, may be undefined if there was an error." - ], - "signature": [ - "Readonly | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpResponse.body", - "type": "Uncategorized", - "tags": [], - "label": "body", - "description": [ - "Parsed body received, may be undefined if there was an error." - ], - "signature": [ - "TResponseBody | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpSetup", - "type": "Interface", - "tags": [], - "label": "HttpSetup", - "description": [], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.HttpSetup.basePath", - "type": "Object", - "tags": [], - "label": "basePath", - "description": [ - "\nAPIs for manipulating the basePath on URL segments.\nSee {@link IBasePath}" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IBasePath", - "text": "IBasePath" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpSetup.anonymousPaths", - "type": "Object", - "tags": [], - "label": "anonymousPaths", - "description": [ - "\nAPIs for denoting certain paths for not requiring authentication" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IAnonymousPaths", - "text": "IAnonymousPaths" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpSetup.externalUrl", - "type": "Object", - "tags": [], - "label": "externalUrl", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IExternalUrl", - "text": "IExternalUrl" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpSetup.intercept", - "type": "Function", - "tags": [], - "label": "intercept", - "description": [ - "\nAdds a new {@link HttpInterceptor} to the global HTTP client." - ], - "signature": [ - "(interceptor: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpInterceptor", - "text": "HttpInterceptor" - }, - ") => () => void" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.HttpSetup.intercept.$1", - "type": "Object", - "tags": [], - "label": "interceptor", - "description": [ - "a {@link HttpInterceptor }" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpInterceptor", - "text": "HttpInterceptor" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [ - "a function for removing the attached interceptor." - ] - }, - { - "parentPluginId": "core", - "id": "def-public.HttpSetup.fetch", - "type": "Function", - "tags": [], - "label": "fetch", - "description": [ - "Makes an HTTP request. Defaults to a GET request unless overridden. See {@link HttpHandler} for options." - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpHandler", - "text": "HttpHandler" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpSetup.delete", - "type": "Function", - "tags": [], - "label": "delete", - "description": [ - "Makes an HTTP request with the DELETE method. See {@link HttpHandler} for options." - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpHandler", - "text": "HttpHandler" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpSetup.get", - "type": "Function", - "tags": [], - "label": "get", - "description": [ - "Makes an HTTP request with the GET method. See {@link HttpHandler} for options." - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpHandler", - "text": "HttpHandler" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpSetup.head", - "type": "Function", - "tags": [], - "label": "head", - "description": [ - "Makes an HTTP request with the HEAD method. See {@link HttpHandler} for options." - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpHandler", - "text": "HttpHandler" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpSetup.options", - "type": "Function", - "tags": [], - "label": "options", - "description": [ - "Makes an HTTP request with the OPTIONS method. See {@link HttpHandler} for options." - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpHandler", - "text": "HttpHandler" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpSetup.patch", - "type": "Function", - "tags": [], - "label": "patch", - "description": [ - "Makes an HTTP request with the PATCH method. See {@link HttpHandler} for options." - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpHandler", - "text": "HttpHandler" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpSetup.post", - "type": "Function", - "tags": [], - "label": "post", - "description": [ - "Makes an HTTP request with the POST method. See {@link HttpHandler} for options." - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpHandler", - "text": "HttpHandler" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpSetup.put", - "type": "Function", - "tags": [], - "label": "put", - "description": [ - "Makes an HTTP request with the PUT method. See {@link HttpHandler} for options." - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpHandler", - "text": "HttpHandler" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpSetup.addLoadingCountSource", - "type": "Function", - "tags": [], - "label": "addLoadingCountSource", - "description": [ - "\nAdds a new source of loading counts. Used to show the global loading indicator when sum of all observed counts are\nmore than 0." - ], - "signature": [ - "(countSource$: ", - "Observable", - ") => void" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.HttpSetup.addLoadingCountSource.$1", - "type": "Object", - "tags": [], - "label": "countSource$", - "description": [ - "an Observable to subscribe to for loading count updates." - ], - "signature": [ - "Observable", - "" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-public.HttpSetup.getLoadingCount$", - "type": "Function", - "tags": [], - "label": "getLoadingCount$", - "description": [ - "\nGet the sum of all loading count sources as a single Observable." - ], - "signature": [ - "() => ", - "Observable", - "" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.IAnonymousPaths", - "type": "Interface", - "tags": [], - "label": "IAnonymousPaths", - "description": [ - "\nAPIs for denoting paths as not requiring authentication" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IAnonymousPaths.isAnonymous", - "type": "Function", - "tags": [], - "label": "isAnonymous", - "description": [ - "\nDetermines whether the provided path doesn't require authentication. `path` should include the current basePath." - ], - "signature": [ - "(path: string) => boolean" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IAnonymousPaths.isAnonymous.$1", - "type": "string", - "tags": [], - "label": "path", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-public.IAnonymousPaths.register", - "type": "Function", - "tags": [], - "label": "register", - "description": [ - "\nRegister `path` as not requiring authentication. `path` should not include the current basePath." - ], - "signature": [ - "(path: string) => void" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IAnonymousPaths.register.$1", - "type": "string", - "tags": [], - "label": "path", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.IBasePath", - "type": "Interface", - "tags": [], - "label": "IBasePath", - "description": [ - "\nAPIs for manipulating the basePath on URL segments." - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IBasePath.get", - "type": "Function", - "tags": [], - "label": "get", - "description": [ - "\nGets the `basePath` string." - ], - "signature": [ - "() => string" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-public.IBasePath.prepend", - "type": "Function", - "tags": [], - "label": "prepend", - "description": [ - "\nPrepends `path` with the basePath." - ], - "signature": [ - "(url: string) => string" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IBasePath.prepend.$1", - "type": "string", - "tags": [], - "label": "url", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-public.IBasePath.remove", - "type": "Function", - "tags": [], - "label": "remove", - "description": [ - "\nRemoves the prepended basePath from the `path`." - ], - "signature": [ - "(url: string) => string" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IBasePath.remove.$1", - "type": "string", - "tags": [], - "label": "url", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-public.IBasePath.serverBasePath", - "type": "string", - "tags": [], - "label": "serverBasePath", - "description": [ - "\nReturns the server's root basePath as configured, without any namespace prefix.\n\nSee {@link BasePath.get} for getting the basePath value for a specific request" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.IBasePath.publicBaseUrl", - "type": "string", - "tags": [], - "label": "publicBaseUrl", - "description": [ - "\nThe server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the\n{@link IBasePath.serverBasePath}.\n" - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.IExternalUrl", - "type": "Interface", - "tags": [], - "label": "IExternalUrl", - "description": [ - "\nAPIs for working with external URLs.\n" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IExternalUrl.isInternalUrl", - "type": "Function", - "tags": [], - "label": "isInternalUrl", - "description": [ - "\nDetermines if the provided URL is an internal url.\n" - ], - "signature": [ - "(relativeOrAbsoluteUrl: string) => boolean" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IExternalUrl.isInternalUrl.$1", - "type": "string", - "tags": [], - "label": "relativeOrAbsoluteUrl", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-public.IExternalUrl.validateUrl", - "type": "Function", - "tags": [], - "label": "validateUrl", - "description": [ - "\nDetermines if the provided URL is a valid location to send users.\nValidation is based on the configured allow list in kibana.yml.\n\nIf the URL is valid, then a URL will be returned.\nOtherwise, this will return null.\n" - ], - "signature": [ - "(relativeOrAbsoluteUrl: string) => URL | null" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IExternalUrl.validateUrl.$1", - "type": "string", - "tags": [], - "label": "relativeOrAbsoluteUrl", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.IHttpFetchError", - "type": "Interface", - "tags": [], - "label": "IHttpFetchError", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IHttpFetchError", - "text": "IHttpFetchError" - }, - " extends Error" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IHttpFetchError.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.IHttpFetchError.request", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - "Request" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.IHttpFetchError.response", - "type": "Object", - "tags": [], - "label": "response", - "description": [], - "signature": [ - "Response | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.IHttpFetchError.req", - "type": "Object", - "tags": [ - "deprecated" - ], - "label": "req", - "description": [], - "signature": [ - "Request" - ], - "path": "src/core/public/http/types.ts", - "deprecated": true, - "removeBy": "8.8.0\n\nNote to maintainers: when looking at usages, mind that typical use could be inside a `catch` block,\nso TS and code-reference navigation might not highlight them.", - "references": [ - { - "plugin": "ml", - "path": "x-pack/plugins/ml/common/util/errors/errors.test.ts" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/common/util/errors/errors.test.ts" - } - ] - }, - { - "parentPluginId": "core", - "id": "def-public.IHttpFetchError.res", - "type": "Object", - "tags": [ - "deprecated" - ], - "label": "res", - "description": [], - "signature": [ - "Response | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": true, - "removeBy": "8.8.0\n\nNote to maintainers: when looking at usages, mind that typical use could be inside a `catch` block,\nso TS and code-reference navigation might not highlight them.", - "references": [] - }, - { - "parentPluginId": "core", - "id": "def-public.IHttpFetchError.body", - "type": "Uncategorized", - "tags": [], - "label": "body", - "description": [], - "signature": [ - "TResponseBody | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.IHttpInterceptController", - "type": "Interface", - "tags": [], - "label": "IHttpInterceptController", - "description": [ - "\nUsed to halt a request Promise chain in a {@link HttpInterceptor}." - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IHttpInterceptController.halted", - "type": "boolean", - "tags": [], - "label": "halted", - "description": [ - "Whether or not this chain has been halted." - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.IHttpInterceptController.halt", - "type": "Function", - "tags": [], - "label": "halt", - "description": [ - "Halt the request Promise chain and do not process further interceptors or response handlers." - ], - "signature": [ - "() => void" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.IHttpResponseInterceptorOverrides", - "type": "Interface", - "tags": [], - "label": "IHttpResponseInterceptorOverrides", - "description": [ - "\nProperties that can be returned by HttpInterceptor.request to override the response." - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IHttpResponseInterceptorOverrides", - "text": "IHttpResponseInterceptorOverrides" - }, - "" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IHttpResponseInterceptorOverrides.response", - "type": "Object", - "tags": [], - "label": "response", - "description": [ - "Raw response received, may be undefined if there was an error." - ], - "signature": [ - "Readonly | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.IHttpResponseInterceptorOverrides.body", - "type": "Uncategorized", - "tags": [], - "label": "body", - "description": [ - "Parsed body received, may be undefined if there was an error." - ], - "signature": [ - "TResponseBody | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.ResponseErrorBody", - "type": "Interface", - "tags": [], - "label": "ResponseErrorBody", - "description": [], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.ResponseErrorBody.message", - "type": "string", - "tags": [], - "label": "message", - "description": [], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.ResponseErrorBody.statusCode", - "type": "number", - "tags": [], - "label": "statusCode", - "description": [], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.ResponseErrorBody.attributes", - "type": "Object", - "tags": [], - "label": "attributes", - "description": [], - "signature": [ - "Record | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - } - ], - "enums": [], - "misc": [ - { - "parentPluginId": "core", - "id": "def-public.HttpStart", - "type": "Type", - "tags": [], - "label": "HttpStart", - "description": [ - "\nSee {@link HttpSetup}" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "initialIsOpen": false - } - ], - "objects": [] - }, - "server": { - "classes": [ - { - "parentPluginId": "core", - "id": "def-server.BasePath", - "type": "Class", - "tags": [], - "label": "BasePath", - "description": [ - "\nAccess or manipulate the Kibana base path\n" - ], - "path": "src/core/server/http/base_path_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.BasePath.serverBasePath", - "type": "string", - "tags": [], - "label": "serverBasePath", - "description": [ - "\nreturns the server's basePath\n\nSee {@link BasePath.get} for getting the basePath value for a specific request" - ], - "path": "src/core/server/http/base_path_service.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.BasePath.publicBaseUrl", - "type": "string", - "tags": [], - "label": "publicBaseUrl", - "description": [ - "\nThe server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the\n{@link BasePath.serverBasePath}.\n" - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/http/base_path_service.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.BasePath.get", - "type": "Function", - "tags": [], - "label": "get", - "description": [ - "\nreturns `basePath` value, specific for an incoming request." - ], - "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ") => string" - ], - "path": "src/core/server/http/base_path_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.BasePath.get.$1", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "path": "src/core/server/http/base_path_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.BasePath.set", - "type": "Function", - "tags": [ - "privateRemarks" - ], - "label": "set", - "description": [ - "\nsets `basePath` value, specific for an incoming request.\n" - ], - "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", requestSpecificBasePath: string) => void" - ], - "path": "src/core/server/http/base_path_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.BasePath.set.$1", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "path": "src/core/server/http/base_path_service.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.BasePath.set.$2", - "type": "string", - "tags": [], - "label": "requestSpecificBasePath", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/http/base_path_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.BasePath.prepend", - "type": "Function", - "tags": [], - "label": "prepend", - "description": [ - "\nPrepends `path` with the basePath." - ], - "signature": [ - "(path: string) => string" - ], - "path": "src/core/server/http/base_path_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.BasePath.prepend.$1", - "type": "string", - "tags": [], - "label": "path", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/http/base_path_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.BasePath.remove", - "type": "Function", - "tags": [], - "label": "remove", - "description": [ - "\nRemoves the prepended basePath from the `path`." - ], - "signature": [ - "(path: string) => string" - ], - "path": "src/core/server/http/base_path_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.BasePath.remove.$1", - "type": "string", - "tags": [], - "label": "path", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/http/base_path_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.CspConfig", - "type": "Class", - "tags": [], - "label": "CspConfig", - "description": [ - "\nCSP configuration for use in Kibana." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CspConfig", - "text": "CspConfig" - }, - " implements ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ICspConfig", - "text": "ICspConfig" - } - ], - "path": "src/core/server/http/csp/csp_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.CspConfig.DEFAULT", - "type": "Object", - "tags": [], - "label": "DEFAULT", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CspConfig", - "text": "CspConfig" - } - ], - "path": "src/core/server/http/csp/csp_config.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.CspConfig.directives", - "type": "Object", - "tags": [], - "label": "#directives", - "description": [], - "signature": [ - "CspDirectives" - ], - "path": "src/core/server/http/csp/csp_config.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.CspConfig.strict", - "type": "boolean", - "tags": [], - "label": "strict", - "description": [], - "path": "src/core/server/http/csp/csp_config.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.CspConfig.warnLegacyBrowsers", - "type": "boolean", - "tags": [], - "label": "warnLegacyBrowsers", - "description": [], - "path": "src/core/server/http/csp/csp_config.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.CspConfig.disableEmbedding", - "type": "boolean", - "tags": [], - "label": "disableEmbedding", - "description": [], - "path": "src/core/server/http/csp/csp_config.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.CspConfig.header", - "type": "string", - "tags": [], - "label": "header", - "description": [], - "path": "src/core/server/http/csp/csp_config.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteValidationError", - "type": "Class", - "tags": [], - "label": "RouteValidationError", - "description": [ - "\nError to return when the validation is not successful." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidationError", - "text": "RouteValidationError" - }, - " extends ", - "SchemaTypeError" - ], - "path": "src/core/server/http/router/validator/validator_error.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RouteValidationError.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" - ], - "path": "src/core/server/http/router/validator/validator_error.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RouteValidationError.Unnamed.$1", - "type": "CompoundType", - "tags": [], - "label": "error", - "description": [], - "signature": [ - "string | Error" - ], - "path": "src/core/server/http/router/validator/validator_error.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.RouteValidationError.Unnamed.$2", - "type": "Array", - "tags": [], - "label": "path", - "description": [], - "signature": [ - "string[]" - ], - "path": "src/core/server/http/router/validator/validator_error.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - } - ], - "functions": [], - "interfaces": [ - { - "parentPluginId": "core", - "id": "def-server.Authenticated", - "type": "Interface", - "tags": [], - "label": "Authenticated", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.Authenticated", - "text": "Authenticated" - }, - " extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthResultParams", - "text": "AuthResultParams" - } - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.Authenticated.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthResultType", - "text": "AuthResultType" - }, - ".authenticated" - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.AuthNotHandled", - "type": "Interface", - "tags": [], - "label": "AuthNotHandled", - "description": [], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.AuthNotHandled.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthResultType", - "text": "AuthResultType" - }, - ".notHandled" - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.AuthRedirected", - "type": "Interface", - "tags": [], - "label": "AuthRedirected", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthRedirected", - "text": "AuthRedirected" - }, - " extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthRedirectedParams", - "text": "AuthRedirectedParams" - } - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.AuthRedirected.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthResultType", - "text": "AuthResultType" - }, - ".redirected" - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.AuthRedirectedParams", - "type": "Interface", - "tags": [], - "label": "AuthRedirectedParams", - "description": [ - "\nResult of auth redirection." - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.AuthRedirectedParams.headers", - "type": "CompoundType", - "tags": [], - "label": "headers", - "description": [ - "\nHeaders to attach for auth redirect.\nMust include \"location\" header" - ], - "signature": [ - "{ location: string; } & ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseHeaders", - "text": "ResponseHeaders" - } - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.AuthResultParams", - "type": "Interface", - "tags": [], - "label": "AuthResultParams", - "description": [ - "\nResult of successful authentication." - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.AuthResultParams.state", - "type": "Object", - "tags": [], - "label": "state", - "description": [ - "\nData to associate with an incoming request. Any downstream plugin may get access to the data." - ], - "signature": [ - "Record | undefined" - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.AuthResultParams.requestHeaders", - "type": "Object", - "tags": [], - "label": "requestHeaders", - "description": [ - "\nAuth specific headers to attach to a request object.\nUsed to perform a request to Elasticsearch on behalf of an authenticated user." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthHeaders", - "text": "AuthHeaders" - }, - " | undefined" - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.AuthResultParams.responseHeaders", - "type": "Object", - "tags": [], - "label": "responseHeaders", - "description": [ - "\nAuth specific headers to attach to a response object.\nUsed to send back authentication mechanism related headers to a client when needed." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthHeaders", - "text": "AuthHeaders" - }, - " | undefined" - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.AuthToolkit", - "type": "Interface", - "tags": [], - "label": "AuthToolkit", - "description": [], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.AuthToolkit.authenticated", - "type": "Function", - "tags": [], - "label": "authenticated", - "description": [ - "Authentication is successful with given credentials, allow request to pass through" - ], - "signature": [ - "(data?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthResultParams", - "text": "AuthResultParams" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthResult", - "text": "AuthResult" - } - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.AuthToolkit.authenticated.$1", - "type": "Object", - "tags": [], - "label": "data", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthResultParams", - "text": "AuthResultParams" - }, - " | undefined" - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.AuthToolkit.notHandled", - "type": "Function", - "tags": [], - "label": "notHandled", - "description": [ - "\nUser has no credentials.\nAllows user to access a resource when authRequired is 'optional'\nRejects a request when authRequired: true" - ], - "signature": [ - "() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthResult", - "text": "AuthResult" - } - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.AuthToolkit.redirected", - "type": "Function", - "tags": [], - "label": "redirected", - "description": [ - "\nRedirects user to another location to complete authentication when authRequired: true\nAllows user to access a resource without redirection when authRequired: 'optional'" - ], - "signature": [ - "(headers: { location: string; } & ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseHeaders", - "text": "ResponseHeaders" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthResult", - "text": "AuthResult" - } - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.AuthToolkit.redirected.$1", - "type": "CompoundType", - "tags": [], - "label": "headers", - "description": [], - "signature": [ - "{ location: string; } & ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseHeaders", - "text": "ResponseHeaders" - } - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.CustomHttpResponseOptions", - "type": "Interface", - "tags": [], - "label": "CustomHttpResponseOptions", - "description": [ - "\nHTTP response parameters for a response with adjustable status code." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.CustomHttpResponseOptions.body", - "type": "Uncategorized", - "tags": [], - "label": "body", - "description": [ - "HTTP message to send to the client" - ], - "signature": [ - "T | undefined" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.CustomHttpResponseOptions.headers", - "type": "CompoundType", - "tags": [], - "label": "headers", - "description": [ - "HTTP Headers with additional information about response" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseHeaders", - "text": "ResponseHeaders" - }, - " | undefined" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.CustomHttpResponseOptions.bypassErrorFormat", - "type": "CompoundType", - "tags": [], - "label": "bypassErrorFormat", - "description": [ - "Bypass the default error formatting" - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.CustomHttpResponseOptions.statusCode", - "type": "number", - "tags": [], - "label": "statusCode", - "description": [], - "path": "src/core/server/http/router/response.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.ErrorHttpResponseOptions", - "type": "Interface", - "tags": [], - "label": "ErrorHttpResponseOptions", - "description": [ - "\nHTTP response parameters" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.ErrorHttpResponseOptions.body", - "type": "CompoundType", - "tags": [], - "label": "body", - "description": [ - "HTTP message to send to the client" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | undefined" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.ErrorHttpResponseOptions.headers", - "type": "CompoundType", - "tags": [], - "label": "headers", - "description": [ - "HTTP Headers with additional information about response" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseHeaders", - "text": "ResponseHeaders" - }, - " | undefined" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpAuth", - "type": "Interface", - "tags": [], - "label": "HttpAuth", - "description": [], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpAuth.get", - "type": "Function", - "tags": [], - "label": "get", - "description": [ - "\nGets authentication state for a request. Returned by `auth` interceptor.\n{@link GetAuthState}" - ], - "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ") => { status: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthStatus", - "text": "AuthStatus" - }, - "; state: T; }" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpAuth.get.$1", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "path": "src/core/server/http/auth_state_storage.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "core", - "id": "def-server.HttpAuth.isAuthenticated", - "type": "Function", - "tags": [], - "label": "isAuthenticated", - "description": [ - "\nReturns authentication status for a request.\n{@link IsAuthenticated}" - ], - "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ") => boolean" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpAuth.isAuthenticated.$1", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "path": "src/core/server/http/auth_state_storage.ts", - "deprecated": false - } - ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpResponseOptions", - "type": "Interface", - "tags": [], - "label": "HttpResponseOptions", - "description": [ - "\nHTTP response parameters" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpResponseOptions.body", - "type": "CompoundType", - "tags": [], - "label": "body", - "description": [ - "HTTP message to send to the client" - ], - "signature": [ - "string | Record | ", - "Stream", - " | Buffer | undefined" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpResponseOptions.headers", - "type": "CompoundType", - "tags": [], - "label": "headers", - "description": [ - "HTTP Headers with additional information about response" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseHeaders", - "text": "ResponseHeaders" - }, - " | undefined" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpResponseOptions.bypassErrorFormat", - "type": "CompoundType", - "tags": [], - "label": "bypassErrorFormat", - "description": [ - "Bypass the default error formatting" - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServerInfo", - "type": "Interface", - "tags": [], - "label": "HttpServerInfo", - "description": [ - "\nInformation about what hostname, port, and protocol the server process is\nrunning on. Note that this may not match the URL that end-users access\nKibana at. For the public URL, see {@link BasePath.publicBaseUrl}." - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpServerInfo.name", - "type": "string", - "tags": [], - "label": "name", - "description": [ - "The name of the Kibana server" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServerInfo.hostname", - "type": "string", - "tags": [], - "label": "hostname", - "description": [ - "The hostname of the server" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServerInfo.port", - "type": "number", - "tags": [], - "label": "port", - "description": [ - "The port the server is listening on" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServerInfo.protocol", - "type": "CompoundType", - "tags": [], - "label": "protocol", - "description": [ - "The protocol used by the server" - ], - "signature": [ - "\"http\" | \"https\" | \"socket\"" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServicePreboot", - "type": "Interface", - "tags": [], - "label": "HttpServicePreboot", - "description": [ - "\nKibana HTTP Service provides an abstraction to work with the HTTP stack at the `preboot` stage. This functionality\nallows Kibana to serve user requests even before Kibana becomes fully operational. Only Core and `preboot` plugins\ncan define HTTP routes at this stage.\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpServicePreboot", - "text": "HttpServicePreboot" - }, - "" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpServicePreboot.registerRoutes", - "type": "Function", - "tags": [], - "label": "registerRoutes", - "description": [ - "\nProvides ability to acquire `preboot` {@link IRouter} instance for a particular top-level path and register handler\nfunctions for any number of nested routes.\n" - ], - "signature": [ - "(path: string, callback: (router: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IRouter", - "text": "IRouter" - }, - ") => void) => void" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpServicePreboot.registerRoutes.$1", - "type": "string", - "tags": [], - "label": "path", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServicePreboot.registerRoutes.$2", - "type": "Function", - "tags": [], - "label": "callback", - "description": [], - "signature": [ - "(router: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IRouter", - "text": "IRouter" - }, - ") => void" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServicePreboot.basePath", - "type": "Object", - "tags": [], - "label": "basePath", - "description": [ - "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." - ], - "signature": [ - "{ get: (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ") => string; set: (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", requestSpecificBasePath: string) => void; remove: (path: string) => string; prepend: (path: string) => string; readonly serverBasePath: string; readonly publicBaseUrl?: string | undefined; }" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServicePreboot.getServerInfo", - "type": "Function", - "tags": [], - "label": "getServerInfo", - "description": [ - "\nProvides common {@link HttpServerInfo | information} about the running preboot http server." - ], - "signature": [ - "() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpServerInfo", - "text": "HttpServerInfo" - } - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup", - "type": "Interface", - "tags": [], - "label": "HttpServiceSetup", - "description": [ - "\nKibana HTTP Service provides own abstraction for work with HTTP stack.\nPlugins don't have direct access to `hapi` server and its primitives anymore. Moreover,\nplugins shouldn't rely on the fact that HTTP Service uses one or another library under the hood.\nThis gives the platform flexibility to upgrade or changing our internal HTTP stack without breaking plugins.\nIf the HTTP Service lacks functionality you need, we are happy to discuss and support your needs.\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpServiceSetup", - "text": "HttpServiceSetup" - }, - "" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.createCookieSessionStorageFactory", - "type": "Function", - "tags": [], - "label": "createCookieSessionStorageFactory", - "description": [ - "\nCreates cookie based session storage factory {@link SessionStorageFactory}" - ], - "signature": [ - "(cookieOptions: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.SessionStorageCookieOptions", - "text": "SessionStorageCookieOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.SessionStorageFactory", - "text": "SessionStorageFactory" - }, - ">" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.createCookieSessionStorageFactory.$1", - "type": "Object", - "tags": [], - "label": "cookieOptions", - "description": [ - "{@link SessionStorageCookieOptions } - options to configure created cookie session storage." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.SessionStorageCookieOptions", - "text": "SessionStorageCookieOptions" - }, - "" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.registerOnPreRouting", - "type": "Function", - "tags": [], - "label": "registerOnPreRouting", - "description": [ - "\nTo define custom logic to perform for incoming requests before server performs a route lookup.\n" - ], - "signature": [ - "(handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreRoutingHandler", - "text": "OnPreRoutingHandler" - }, - ") => void" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.registerOnPreRouting.$1", - "type": "Function", - "tags": [], - "label": "handler", - "description": [ - "{@link OnPreRoutingHandler } - function to call." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreRoutingHandler", - "text": "OnPreRoutingHandler" - } - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.registerOnPreAuth", - "type": "Function", - "tags": [], - "label": "registerOnPreAuth", - "description": [ - "\nTo define custom logic to perform for incoming requests before\nthe Auth interceptor performs a check that user has access to requested resources.\n" - ], - "signature": [ - "(handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreAuthHandler", - "text": "OnPreAuthHandler" - }, - ") => void" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.registerOnPreAuth.$1", - "type": "Function", - "tags": [], - "label": "handler", - "description": [ - "{@link OnPreRoutingHandler } - function to call." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "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": [ - "{@link AuthenticationHandler } - function to perform authentication." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthenticationHandler", - "text": "AuthenticationHandler" - } - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "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, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.registerOnPostAuth.$1", - "type": "Function", - "tags": [], - "label": "handler", - "description": [ - "{@link OnPostAuthHandler } - function to call." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "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": [ - "{@link OnPreResponseHandler } - function to call." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreResponseHandler", - "text": "OnPreResponseHandler" - } - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.basePath", - "type": "Object", - "tags": [], - "label": "basePath", - "description": [ - "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." - ], - "signature": [ - "{ get: (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ") => string; set: (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", requestSpecificBasePath: string) => void; remove: (path: string) => string; prepend: (path: string) => string; readonly serverBasePath: string; readonly publicBaseUrl?: string | undefined; }" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.csp", - "type": "Object", - "tags": [], - "label": "csp", - "description": [ - "\nThe CSP config used for Kibana." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ICspConfig", - "text": "ICspConfig" - } - ], - "path": "src/core/server/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.createRouter", - "type": "Function", - "tags": [], - "label": "createRouter", - "description": [ - "\nProvides ability to declare a handler function for a particular path and HTTP request method.\n" - ], - "signature": [ - "() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IRouter", - "text": "IRouter" - }, - "" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.registerRouteHandlerContext", - "type": "Function", - "tags": [], - "label": "registerRouteHandlerContext", - "description": [ - "\nRegister a context provider for a route handler." - ], - "signature": [ - ">(contextName: ContextName, provider: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RequestHandlerContextProvider", - "text": "RequestHandlerContextProvider" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IContextContainer", - "text": "IContextContainer" - } - ], - "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.RequestHandlerContextProvider", - "text": "RequestHandlerContextProvider" - }, - "" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.getServerInfo", - "type": "Function", - "tags": [], - "label": "getServerInfo", - "description": [ - "\nProvides common {@link HttpServerInfo | information} about the running http server." - ], - "signature": [ - "() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpServerInfo", - "text": "HttpServerInfo" - } - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServiceStart", - "type": "Interface", - "tags": [], - "label": "HttpServiceStart", - "description": [], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpServiceStart.basePath", - "type": "Object", - "tags": [], - "label": "basePath", - "description": [ - "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." - ], - "signature": [ - "{ get: (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ") => string; set: (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", requestSpecificBasePath: string) => void; remove: (path: string) => string; prepend: (path: string) => string; readonly serverBasePath: string; readonly publicBaseUrl?: string | undefined; }" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServiceStart.auth", - "type": "Object", - "tags": [], - "label": "auth", - "description": [ - "\nAuth status.\nSee {@link HttpAuth}" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpAuth", - "text": "HttpAuth" - } - ], - "path": "src/core/server/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServiceStart.getServerInfo", - "type": "Function", - "tags": [], - "label": "getServerInfo", - "description": [ - "\nProvides common {@link HttpServerInfo | information} about the running http server." - ], - "signature": [ - "() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpServerInfo", - "text": "HttpServerInfo" - } - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.ICspConfig", - "type": "Interface", - "tags": [], - "label": "ICspConfig", - "description": [ - "\nCSP configuration for use in Kibana." - ], - "path": "src/core/server/http/csp/csp_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.ICspConfig.strict", - "type": "boolean", - "tags": [], - "label": "strict", - "description": [ - "\nSpecify whether browsers that do not support CSP should be\nable to use Kibana. Use `true` to block and `false` to allow." - ], - "path": "src/core/server/http/csp/csp_config.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.ICspConfig.warnLegacyBrowsers", - "type": "boolean", - "tags": [], - "label": "warnLegacyBrowsers", - "description": [ - "\nSpecify whether users with legacy browsers should be warned\nabout their lack of Kibana security compliance." - ], - "path": "src/core/server/http/csp/csp_config.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.ICspConfig.disableEmbedding", - "type": "boolean", - "tags": [], - "label": "disableEmbedding", - "description": [ - "\nWhether or not embedding (using iframes) should be allowed by the CSP. If embedding is disabled, a restrictive 'frame-ancestors' rule will be added to the default CSP rules." - ], - "path": "src/core/server/http/csp/csp_config.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.ICspConfig.header", - "type": "string", - "tags": [], - "label": "header", - "description": [ - "\nThe CSP rules in a formatted directives string for use\nin a `Content-Security-Policy` header." - ], - "path": "src/core/server/http/csp/csp_config.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.IExternalUrlConfig", - "type": "Interface", - "tags": [], - "label": "IExternalUrlConfig", - "description": [ - "\nExternal Url configuration for use in Kibana." - ], - "path": "src/core/server/http/external_url/external_url_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IExternalUrlConfig.policy", - "type": "Array", - "tags": [], - "label": "policy", - "description": [ - "\nA set of policies describing which external urls are allowed." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IExternalUrlPolicy", - "text": "IExternalUrlPolicy" - }, - "[]" - ], - "path": "src/core/server/http/external_url/external_url_config.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.IExternalUrlPolicy", - "type": "Interface", - "tags": [], - "label": "IExternalUrlPolicy", - "description": [ - "\nA policy describing whether access to an external destination is allowed." - ], - "path": "src/core/server/http/external_url/external_url_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IExternalUrlPolicy.allow", - "type": "boolean", - "tags": [], - "label": "allow", - "description": [ - "\nIndicates if this policy allows or denies access to the described destination." - ], - "path": "src/core/server/http/external_url/external_url_config.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IExternalUrlPolicy.host", - "type": "string", - "tags": [], - "label": "host", - "description": [ - "\nOptional host describing the external destination.\nMay be combined with `protocol`.\n" - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/http/external_url/external_url_config.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IExternalUrlPolicy.protocol", - "type": "string", - "tags": [], - "label": "protocol", - "description": [ - "\nOptional protocol describing the external destination.\nMay be combined with `host`.\n" - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/http/external_url/external_url_config.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.IKibanaResponse", - "type": "Interface", - "tags": [], - "label": "IKibanaResponse", - "description": [ - "\nA response data object, expected to returned as a result of {@link RequestHandler} execution" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - "" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IKibanaResponse.status", - "type": "number", - "tags": [], - "label": "status", - "description": [], - "path": "src/core/server/http/router/response.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IKibanaResponse.payload", - "type": "Uncategorized", - "tags": [], - "label": "payload", - "description": [], - "signature": [ - "T | undefined" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IKibanaResponse.options", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - } - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.IKibanaSocket", - "type": "Interface", - "tags": [], - "label": "IKibanaSocket", - "description": [ - "\nA tiny abstraction for TCP socket." - ], - "path": "src/core/server/http/router/socket.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IKibanaSocket.getPeerCertificate", - "type": "Function", - "tags": [], - "label": "getPeerCertificate", - "description": [], - "signature": [ - "{ (detailed: true): ", - "DetailedPeerCertificate", - " | null; (detailed: false): ", - "PeerCertificate", - " | null; (detailed?: boolean | undefined): ", - "PeerCertificate", - " | ", - "DetailedPeerCertificate", - " | null; }" - ], - "path": "src/core/server/http/router/socket.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IKibanaSocket.getPeerCertificate.$1", - "type": "boolean", - "tags": [], - "label": "detailed", - "description": [], - "signature": [ - "true" - ], - "path": "src/core/server/http/router/socket.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.IKibanaSocket.getPeerCertificate", - "type": "Function", - "tags": [], - "label": "getPeerCertificate", - "description": [], - "signature": [ - "{ (detailed: true): ", - "DetailedPeerCertificate", - " | null; (detailed: false): ", - "PeerCertificate", - " | null; (detailed?: boolean | undefined): ", - "PeerCertificate", - " | ", - "DetailedPeerCertificate", - " | null; }" - ], - "path": "src/core/server/http/router/socket.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IKibanaSocket.getPeerCertificate.$1", - "type": "boolean", - "tags": [], - "label": "detailed", - "description": [], - "signature": [ - "false" - ], - "path": "src/core/server/http/router/socket.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.IKibanaSocket.getPeerCertificate", - "type": "Function", - "tags": [], - "label": "getPeerCertificate", - "description": [ - "\nReturns an object representing the peer's certificate.\nThe returned object has some properties corresponding to the field of the certificate.\nIf detailed argument is true the full chain with issuer property will be returned,\nif false only the top certificate without issuer property.\nIf the peer does not provide a certificate, it returns null." - ], - "signature": [ - "{ (detailed: true): ", - "DetailedPeerCertificate", - " | null; (detailed: false): ", - "PeerCertificate", - " | null; (detailed?: boolean | undefined): ", - "PeerCertificate", - " | ", - "DetailedPeerCertificate", - " | null; }" - ], - "path": "src/core/server/http/router/socket.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IKibanaSocket.getPeerCertificate.$1", - "type": "CompoundType", - "tags": [], - "label": "detailed", - "description": [ - "- If true; the full chain with issuer property will be returned." - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/http/router/socket.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [ - "An object representing the peer's certificate." - ] - }, - { - "parentPluginId": "core", - "id": "def-server.IKibanaSocket.getProtocol", - "type": "Function", - "tags": [], - "label": "getProtocol", - "description": [ - "\nReturns a string containing the negotiated SSL/TLS protocol version of the current connection. The value 'unknown' will be returned for\nconnected sockets that have not completed the handshaking process. The value null will be returned for server sockets or disconnected\nclient sockets. See https://www.openssl.org/docs/man1.0.2/ssl/SSL_get_version.html for more information." - ], - "signature": [ - "() => string | null" - ], - "path": "src/core/server/http/router/socket.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.IKibanaSocket.renegotiate", - "type": "Function", - "tags": [], - "label": "renegotiate", - "description": [ - "\nRenegotiates a connection to obtain the peer's certificate. This cannot be used when the protocol version is TLSv1.3." - ], - "signature": [ - "(options: { rejectUnauthorized?: boolean | undefined; requestCert?: boolean | undefined; }) => Promise" - ], - "path": "src/core/server/http/router/socket.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IKibanaSocket.renegotiate.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "path": "src/core/server/http/router/socket.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IKibanaSocket.renegotiate.$1.rejectUnauthorized", - "type": "CompoundType", - "tags": [], - "label": "rejectUnauthorized", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/http/router/socket.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IKibanaSocket.renegotiate.$1.requestCert", - "type": "CompoundType", - "tags": [], - "label": "requestCert", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/http/router/socket.ts", - "deprecated": false - } - ] - } - ], - "returnComment": [ - "A Promise that will be resolved if renegotiation succeeded, or will be rejected if renegotiation failed." - ] - }, - { - "parentPluginId": "core", - "id": "def-server.IKibanaSocket.authorized", - "type": "CompoundType", - "tags": [], - "label": "authorized", - "description": [ - "\nIndicates whether or not the peer certificate was signed by one of the specified CAs. When TLS\nisn't used the value is `undefined`." - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/http/router/socket.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IKibanaSocket.authorizationError", - "type": "Object", - "tags": [], - "label": "authorizationError", - "description": [ - "\nThe reason why the peer's certificate has not been verified. This property becomes available\nonly when `authorized` is `false`." - ], - "signature": [ - "Error | undefined" - ], - "path": "src/core/server/http/router/socket.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter", - "type": "Interface", - "tags": [], - "label": "IRouter", - "description": [ - "\nRegisters route handlers for specified resource path and method.\nSee {@link RouteConfig} and {@link RequestHandler} for more information about arguments to route registrations.\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IRouter", - "text": "IRouter" - }, - "" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IRouter.routerPath", - "type": "string", - "tags": [], - "label": "routerPath", - "description": [ - "\nResulted path" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.get", - "type": "Function", - "tags": [], - "label": "get", - "description": [ - "\nRegister a route handler for `GET` request." - ], - "signature": [ - "(route: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfig", - "text": "RouteConfig" - }, - ", handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RequestHandler", - "text": "RequestHandler" - }, - " | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | 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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }>) => void" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IRouter.get.$1", - "type": "Object", - "tags": [], - "label": "route", - "description": [ - "{@link RouteConfig } - a route configuration." - ], - "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.IRouter.get.$2", - "type": "Function", - "tags": [], - "label": "handler", - "description": [ - "{@link RequestHandler } - a function to call to respond to an incoming request" - ], - "signature": [ - "(context: Context, request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: { custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | 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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; 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.IRouter.get.$2.$1", - "type": "Uncategorized", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "Context" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.get.$2.$2", - "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.IRouter.get.$2.$3", - "type": "Uncategorized", - "tags": [], - "label": "response", - "description": [], - "signature": [ - "ResponseFactory" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - } - ] - } - ] - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.post", - "type": "Function", - "tags": [], - "label": "post", - "description": [ - "\nRegister a route handler for `POST` request." - ], - "signature": [ - "(route: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfig", - "text": "RouteConfig" - }, - ", handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RequestHandler", - "text": "RequestHandler" - }, - " | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | 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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }>) => void" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IRouter.post.$1", - "type": "Object", - "tags": [], - "label": "route", - "description": [ - "{@link RouteConfig } - a route configuration." - ], - "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.IRouter.post.$2", - "type": "Function", - "tags": [], - "label": "handler", - "description": [ - "{@link RequestHandler } - a function to call to respond to an incoming request" - ], - "signature": [ - "(context: Context, request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: { custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | 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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; 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.IRouter.post.$2.$1", - "type": "Uncategorized", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "Context" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.post.$2.$2", - "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.IRouter.post.$2.$3", - "type": "Uncategorized", - "tags": [], - "label": "response", - "description": [], - "signature": [ - "ResponseFactory" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - } - ] - } - ] - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.put", - "type": "Function", - "tags": [], - "label": "put", - "description": [ - "\nRegister a route handler for `PUT` request." - ], - "signature": [ - "(route: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfig", - "text": "RouteConfig" - }, - ", handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RequestHandler", - "text": "RequestHandler" - }, - " | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | 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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }>) => void" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IRouter.put.$1", - "type": "Object", - "tags": [], - "label": "route", - "description": [ - "{@link RouteConfig } - a route configuration." - ], - "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.IRouter.put.$2", - "type": "Function", - "tags": [], - "label": "handler", - "description": [ - "{@link RequestHandler } - a function to call to respond to an incoming request" - ], - "signature": [ - "(context: Context, request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: { custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | 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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; 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.IRouter.put.$2.$1", - "type": "Uncategorized", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "Context" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.put.$2.$2", - "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.IRouter.put.$2.$3", - "type": "Uncategorized", - "tags": [], - "label": "response", - "description": [], - "signature": [ - "ResponseFactory" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - } - ] - } - ] - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.patch", - "type": "Function", - "tags": [], - "label": "patch", - "description": [ - "\nRegister a route handler for `PATCH` request." - ], - "signature": [ - "(route: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfig", - "text": "RouteConfig" - }, - ", handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RequestHandler", - "text": "RequestHandler" - }, - " | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | 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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }>) => void" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IRouter.patch.$1", - "type": "Object", - "tags": [], - "label": "route", - "description": [ - "{@link RouteConfig } - a route configuration." - ], - "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.IRouter.patch.$2", - "type": "Function", - "tags": [], - "label": "handler", - "description": [ - "{@link RequestHandler } - a function to call to respond to an incoming request" - ], - "signature": [ - "(context: Context, request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: { custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | 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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; 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.IRouter.patch.$2.$1", - "type": "Uncategorized", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "Context" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.patch.$2.$2", - "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.IRouter.patch.$2.$3", - "type": "Uncategorized", - "tags": [], - "label": "response", - "description": [], - "signature": [ - "ResponseFactory" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - } - ] - } - ] - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.delete", - "type": "Function", - "tags": [], - "label": "delete", - "description": [ - "\nRegister a route handler for `DELETE` request." - ], - "signature": [ - "(route: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfig", - "text": "RouteConfig" - }, - ", handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RequestHandler", - "text": "RequestHandler" - }, - " | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | 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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }>) => void" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IRouter.delete.$1", - "type": "Object", - "tags": [], - "label": "route", - "description": [ - "{@link RouteConfig } - a route configuration." - ], - "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.IRouter.delete.$2", - "type": "Function", - "tags": [], - "label": "handler", - "description": [ - "{@link RequestHandler } - a function to call to respond to an incoming request" - ], - "signature": [ - "(context: Context, request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: { custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | 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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; 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.IRouter.delete.$2.$1", - "type": "Uncategorized", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "Context" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.delete.$2.$2", - "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.IRouter.delete.$2.$3", - "type": "Uncategorized", - "tags": [], - "label": "response", - "description": [], - "signature": [ - "ResponseFactory" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - } - ] - } - ] - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.handleLegacyErrors", - "type": "Function", - "tags": [], - "label": "handleLegacyErrors", - "description": [ - "\nWrap a router handler to catch and converts legacy boom errors to proper custom errors." - ], - "signature": [ - " | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | 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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; } = { custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | 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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }>(handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RequestHandler", - "text": "RequestHandler" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RequestHandler", - "text": "RequestHandler" - }, - "" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IRouter.handleLegacyErrors.$1", - "type": "Function", - "tags": [], - "label": "handler", - "description": [ - "{@link RequestHandler } - a route handler to wrap" - ], - "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.IRouter.handleLegacyErrors.$1.$1", - "type": "Uncategorized", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "Context" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.handleLegacyErrors.$1.$2", - "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.IRouter.handleLegacyErrors.$1.$3", - "type": "Uncategorized", - "tags": [], - "label": "response", - "description": [], - "signature": [ - "ResponseFactory" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - } - ] - } - ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequest", - "type": "Interface", - "tags": [], - "label": "KibanaRequest", - "description": [ - "\nKibana specific abstraction for an incoming request." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.KibanaRequest.id", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "\nA identifier to identify this request.\n" - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequest.uuid", - "type": "string", - "tags": [], - "label": "uuid", - "description": [ - "\nA UUID to identify this request.\n" - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequest.url", - "type": "Object", - "tags": [], - "label": "url", - "description": [ - "a WHATWG URL standard object." - ], - "signature": [ - "URL" - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequest.route", - "type": "Object", - "tags": [], - "label": "route", - "description": [ - "matched route details" - ], - "signature": [ - "{ readonly path: string; readonly method: ", - "RecursiveReadonly", - "; readonly options: ", - "RecursiveReadonly", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequestRouteOptions", - "text": "KibanaRequestRouteOptions" - }, - ">; }" - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequest.headers", - "type": "CompoundType", - "tags": [], - "label": "headers", - "description": [ - "\nReadonly copy of incoming request headers." - ], - "signature": [ - "{ warning?: string | string[] | undefined; from?: string | string[] | undefined; date?: string | string[] | undefined; expires?: string | string[] | undefined; range?: string | string[] | undefined; origin?: string | string[] | undefined; location?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; etag?: string | string[] | undefined; expect?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequest.isSystemRequest", - "type": "boolean", - "tags": [], - "label": "isSystemRequest", - "description": [ - "\nWhether or not the request is a \"system request\" rather than an application-level request.\nCan be set on the client using the `HttpFetchOptions#asSystemRequest` option." - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequest.socket", - "type": "Object", - "tags": [], - "label": "socket", - "description": [ - "\nThe socket associated with this request.\nSee {@link IKibanaSocket}." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaSocket", - "text": "IKibanaSocket" - } - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequest.events", - "type": "Object", - "tags": [], - "label": "events", - "description": [ - "\nAllow to listen to events bound to this request.\nSee {@link KibanaRequestEvents}." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequestEvents", - "text": "KibanaRequestEvents" - } - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequest.auth", - "type": "Object", - "tags": [], - "label": "auth", - "description": [ - "\nThe auth status of this request.\nSee {@link KibanaRequestAuth}." - ], - "signature": [ - "KibanaRequestAuth" - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequest.rewrittenUrl", - "type": "Object", - "tags": [], - "label": "rewrittenUrl", - "description": [ - "\nURL rewritten in onPreRouting request interceptor." - ], - "signature": [ - "URL", - " | undefined" - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequest.params", - "type": "Uncategorized", - "tags": [], - "label": "params", - "description": [ - "\nThe path parameter of this request." - ], - "signature": [ - "Params" - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequest.query", - "type": "Uncategorized", - "tags": [], - "label": "query", - "description": [ - "\nThe query parameter of this request." - ], - "signature": [ - "Query" - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequest.body", - "type": "Uncategorized", - "tags": [], - "label": "body", - "description": [ - "\nThe body payload of this request." - ], - "signature": [ - "Body" - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequestEvents", - "type": "Interface", - "tags": [], - "label": "KibanaRequestEvents", - "description": [ - "\nRequest events." - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.KibanaRequestEvents.aborted$", - "type": "Object", - "tags": [], - "label": "aborted$", - "description": [ - "\nObservable that emits once if and when the request has been aborted." - ], - "signature": [ - "Observable", - "" - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequestEvents.completed$", - "type": "Object", - "tags": [], - "label": "completed$", - "description": [ - "\nObservable that emits once if and when the request has been completely handled.\n" - ], - "signature": [ - "Observable", - "" - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequestRoute", - "type": "Interface", - "tags": [], - "label": "KibanaRequestRoute", - "description": [ - "\nRequest specific route information exposed to a handler." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequestRoute", - "text": "KibanaRequestRoute" - }, - "" - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.KibanaRequestRoute.path", - "type": "string", - "tags": [], - "label": "path", - "description": [], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequestRoute.method", - "type": "Uncategorized", - "tags": [], - "label": "method", - "description": [], - "signature": [ - "Method" - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequestRoute.options", - "type": "Uncategorized", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "Method extends \"options\" | \"get\" ? Required, \"body\">> : Required<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfigOptions", - "text": "RouteConfigOptions" - }, - ">" - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPostAuthToolkit", - "type": "Interface", - "tags": [], - "label": "OnPostAuthToolkit", - "description": [], - "path": "src/core/server/http/lifecycle/on_post_auth.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.OnPostAuthToolkit.next", - "type": "Function", - "tags": [], - "label": "next", - "description": [ - "To pass request to the next handler" - ], - "signature": [ - "() => Next" - ], - "path": "src/core/server/http/lifecycle/on_post_auth.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreAuthToolkit", - "type": "Interface", - "tags": [], - "label": "OnPreAuthToolkit", - "description": [], - "path": "src/core/server/http/lifecycle/on_pre_auth.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.OnPreAuthToolkit.next", - "type": "Function", - "tags": [], - "label": "next", - "description": [ - "To pass request to the next handler" - ], - "signature": [ - "() => Next" - ], - "path": "src/core/server/http/lifecycle/on_pre_auth.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreResponseExtensions", - "type": "Interface", - "tags": [], - "label": "OnPreResponseExtensions", - "description": [ - "\nAdditional data to extend a response." - ], - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.OnPreResponseExtensions.headers", - "type": "CompoundType", - "tags": [], - "label": "headers", - "description": [ - "additional headers to attach to the response" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseHeaders", - "text": "ResponseHeaders" - }, - " | undefined" - ], - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreResponseInfo", - "type": "Interface", - "tags": [], - "label": "OnPreResponseInfo", - "description": [ - "\nResponse status code." - ], - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.OnPreResponseInfo.statusCode", - "type": "number", - "tags": [], - "label": "statusCode", - "description": [], - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreResponseRender", - "type": "Interface", - "tags": [], - "label": "OnPreResponseRender", - "description": [ - "\nAdditional data to extend a response when rendering a new body" - ], - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.OnPreResponseRender.headers", - "type": "CompoundType", - "tags": [], - "label": "headers", - "description": [ - "additional headers to attach to the response" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseHeaders", - "text": "ResponseHeaders" - }, - " | undefined" - ], - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreResponseRender.body", - "type": "string", - "tags": [], - "label": "body", - "description": [ - "the body to use in the response" - ], - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreResponseToolkit", - "type": "Interface", - "tags": [], - "label": "OnPreResponseToolkit", - "description": [ - "\nA tool set defining an outcome of OnPreResponse interceptor for incoming request." - ], - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.OnPreResponseToolkit.render", - "type": "Function", - "tags": [], - "label": "render", - "description": [ - "To override the response with a different body" - ], - "signature": [ - "(responseRender: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreResponseRender", - "text": "OnPreResponseRender" - }, - ") => OnPreResponseResult" - ], - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.OnPreResponseToolkit.render.$1", - "type": "Object", - "tags": [], - "label": "responseRender", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreResponseRender", - "text": "OnPreResponseRender" - } - ], - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreResponseToolkit.next", - "type": "Function", - "tags": [], - "label": "next", - "description": [ - "To pass request to the next handler" - ], - "signature": [ - "(responseExtensions?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreResponseExtensions", - "text": "OnPreResponseExtensions" - }, - " | undefined) => OnPreResponseResult" - ], - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.OnPreResponseToolkit.next.$1", - "type": "Object", - "tags": [], - "label": "responseExtensions", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreResponseExtensions", - "text": "OnPreResponseExtensions" - }, - " | undefined" - ], - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreRoutingToolkit", - "type": "Interface", - "tags": [], - "label": "OnPreRoutingToolkit", - "description": [], - "path": "src/core/server/http/lifecycle/on_pre_routing.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.OnPreRoutingToolkit.next", - "type": "Function", - "tags": [], - "label": "next", - "description": [ - "To pass request to the next handler" - ], - "signature": [ - "() => OnPreRoutingResult" - ], - "path": "src/core/server/http/lifecycle/on_pre_routing.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreRoutingToolkit.rewriteUrl", - "type": "Function", - "tags": [], - "label": "rewriteUrl", - "description": [ - "Rewrite requested resources url before is was authenticated and routed to a handler" - ], - "signature": [ - "(url: string) => OnPreRoutingResult" - ], - "path": "src/core/server/http/lifecycle/on_pre_routing.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "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, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteConfig", - "type": "Interface", - "tags": [], - "label": "RouteConfig", - "description": [ - "\nRoute specific configuration." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfig", - "text": "RouteConfig" - }, - "" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RouteConfig.path", - "type": "string", - "tags": [], - "label": "path", - "description": [ - "\nThe endpoint _within_ the router path to register the route.\n" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteConfig.validate", - "type": "CompoundType", - "tags": [], - "label": "validate", - "description": [ - "\nA schema created with `@kbn/config-schema` that every request will be validated against.\n" - ], - "signature": [ - "false | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidatorFullConfig", - "text": "RouteValidatorFullConfig" - }, - "" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteConfig.options", - "type": "Object", - "tags": [], - "label": "options", - "description": [ - "\nAdditional route options {@link RouteConfigOptions}." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfigOptions", - "text": "RouteConfigOptions" - }, - " | undefined" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteConfigOptions", - "type": "Interface", - "tags": [], - "label": "RouteConfigOptions", - "description": [ - "\nAdditional route options." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfigOptions", - "text": "RouteConfigOptions" - }, - "" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RouteConfigOptions.authRequired", - "type": "CompoundType", - "tags": [], - "label": "authRequired", - "description": [ - "\nDefines authentication mode for a route:\n- true. A user has to have valid credentials to access a resource\n- false. A user can access a resource without any credentials.\n- 'optional'. A user can access a resource, and will be authenticated if provided credentials are valid.\n Can be useful when we grant access to a resource but want to identify a user if possible.\n\nDefaults to `true` if an auth mechanism is registered." - ], - "signature": [ - "boolean | \"optional\" | undefined" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteConfigOptions.xsrfRequired", - "type": "Uncategorized", - "tags": [], - "label": "xsrfRequired", - "description": [ - "\nDefines xsrf protection requirements for a route:\n- true. Requires an incoming POST/PUT/DELETE request to contain `kbn-xsrf` header.\n- false. Disables xsrf protection.\n\nSet to true by default" - ], - "signature": [ - "(Method extends \"get\" ? never : boolean) | undefined" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteConfigOptions.tags", - "type": "Object", - "tags": [], - "label": "tags", - "description": [ - "\nAdditional metadata tag strings to attach to the route." - ], - "signature": [ - "readonly string[] | undefined" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteConfigOptions.body", - "type": "Uncategorized", - "tags": [], - "label": "body", - "description": [ - "\nAdditional body options {@link RouteConfigOptionsBody}." - ], - "signature": [ - "(Method extends \"options\" | \"get\" ? undefined : ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfigOptionsBody", - "text": "RouteConfigOptionsBody" - }, - ") | undefined" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteConfigOptions.timeout", - "type": "Object", - "tags": [], - "label": "timeout", - "description": [ - "\nDefines per-route timeouts." - ], - "signature": [ - "{ payload?: (Method extends \"options\" | \"get\" ? undefined : number) | undefined; idleSocket?: number | undefined; } | undefined" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteConfigOptionsBody", - "type": "Interface", - "tags": [], - "label": "RouteConfigOptionsBody", - "description": [ - "\nAdditional body options for a route" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RouteConfigOptionsBody.accepts", - "type": "CompoundType", - "tags": [], - "label": "accepts", - "description": [ - "\nA string or an array of strings with the allowed mime types for the endpoint. Use this settings to limit the set of allowed mime types. Note that allowing additional mime types not listed\nabove will not enable them to be parsed, and if parse is true, the request will result in an error response.\n\nDefault value: allows parsing of the following mime types:\n* application/json\n* application/*+json\n* application/octet-stream\n* application/x-www-form-urlencoded\n* multipart/form-data\n* text/*" - ], - "signature": [ - "string | string[] | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteContentType", - "text": "RouteContentType" - }, - "[] | undefined" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteConfigOptionsBody.maxBytes", - "type": "number", - "tags": [], - "label": "maxBytes", - "description": [ - "\nLimits the size of incoming payloads to the specified byte count. Allowing very large payloads may cause the server to run out of memory.\n\nDefault value: The one set in the kibana.yml config file under the parameter `server.maxPayload`." - ], - "signature": [ - "number | undefined" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteConfigOptionsBody.output", - "type": "CompoundType", - "tags": [], - "label": "output", - "description": [ - "\nThe processed payload format. The value must be one of:\n* 'data' - the incoming payload is read fully into memory. If parse is true, the payload is parsed (JSON, form-decoded, multipart) based on the 'Content-Type' header. If parse is false, a raw\nBuffer is returned.\n* 'stream' - the incoming payload is made available via a Stream.Readable interface. If the payload is 'multipart/form-data' and parse is true, field values are presented as text while files\nare provided as streams. File streams from a 'multipart/form-data' upload will also have a hapi property containing the filename and headers properties. Note that payload streams for multipart\npayloads are a synthetic interface created on top of the entire multipart content loaded into memory. To avoid loading large multipart payloads into memory, set parse to false and handle the\nmultipart payload in the handler using a streaming parser (e.g. pez).\n\nDefault value: 'data', unless no validation.body is provided in the route definition. In that case the default is 'stream' to alleviate memory pressure." - ], - "signature": [ - "\"data\" | \"stream\" | undefined" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteConfigOptionsBody.parse", - "type": "CompoundType", - "tags": [], - "label": "parse", - "description": [ - "\nDetermines if the incoming payload is processed or presented raw. Available values:\n* true - if the request 'Content-Type' matches the allowed mime types set by allow (for the whole payload as well as parts), the payload is converted into an object when possible. If the\nformat is unknown, a Bad Request (400) error response is sent. Any known content encoding is decoded.\n* false - the raw payload is returned unmodified.\n* 'gunzip' - the raw payload is returned unmodified after any known content encoding is decoded.\n\nDefault value: true, unless no validation.body is provided in the route definition. In that case the default is false to alleviate memory pressure." - ], - "signature": [ - "boolean | \"gunzip\" | undefined" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteValidationResultFactory", - "type": "Interface", - "tags": [], - "label": "RouteValidationResultFactory", - "description": [ - "\nValidation result factory to be used in the custom validation function to return the valid data or validation errors\n\nSee {@link RouteValidationFunction}.\n" - ], - "path": "src/core/server/http/router/validator/validator.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RouteValidationResultFactory.ok", - "type": "Function", - "tags": [], - "label": "ok", - "description": [], - "signature": [ - "(value: T) => { value: T; }" - ], - "path": "src/core/server/http/router/validator/validator.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RouteValidationResultFactory.ok.$1", - "type": "Uncategorized", - "tags": [], - "label": "value", - "description": [], - "signature": [ - "T" - ], - "path": "src/core/server/http/router/validator/validator.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.RouteValidationResultFactory.badRequest", - "type": "Function", - "tags": [], - "label": "badRequest", - "description": [], - "signature": [ - "(error: string | Error, path?: string[] | undefined) => { error: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidationError", - "text": "RouteValidationError" - }, - "; }" - ], - "path": "src/core/server/http/router/validator/validator.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RouteValidationResultFactory.badRequest.$1", - "type": "CompoundType", - "tags": [], - "label": "error", - "description": [], - "signature": [ - "string | Error" - ], - "path": "src/core/server/http/router/validator/validator.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.RouteValidationResultFactory.badRequest.$2", - "type": "Array", - "tags": [], - "label": "path", - "description": [], - "signature": [ - "string[] | undefined" - ], - "path": "src/core/server/http/router/validator/validator.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteValidatorConfig", - "type": "Interface", - "tags": [], - "label": "RouteValidatorConfig", - "description": [ - "\nThe configuration object to the RouteValidator class.\nSet `params`, `query` and/or `body` to specify the validation logic to follow for that property.\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidatorConfig", - "text": "RouteValidatorConfig" - }, - "" - ], - "path": "src/core/server/http/router/validator/validator.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RouteValidatorConfig.params", - "type": "CompoundType", - "tags": [], - "label": "params", - "description": [ - "\nValidation logic for the URL params" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidationSpec", - "text": "RouteValidationSpec" - }, - "

| undefined" - ], - "path": "src/core/server/http/router/validator/validator.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteValidatorConfig.query", - "type": "CompoundType", - "tags": [], - "label": "query", - "description": [ - "\nValidation logic for the Query params" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidationSpec", - "text": "RouteValidationSpec" - }, - " | undefined" - ], - "path": "src/core/server/http/router/validator/validator.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteValidatorConfig.body", - "type": "CompoundType", - "tags": [], - "label": "body", - "description": [ - "\nValidation logic for the body payload" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidationSpec", - "text": "RouteValidationSpec" - }, - " | undefined" - ], - "path": "src/core/server/http/router/validator/validator.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteValidatorOptions", - "type": "Interface", - "tags": [], - "label": "RouteValidatorOptions", - "description": [ - "\nAdditional options for the RouteValidator class to modify its default behaviour.\n" - ], - "path": "src/core/server/http/router/validator/validator.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RouteValidatorOptions.unsafe", - "type": "Object", - "tags": [], - "label": "unsafe", - "description": [ - "\nSet the `unsafe` config to avoid running some additional internal *safe* validations on top of your custom validation" - ], - "signature": [ - "{ params?: boolean | undefined; query?: boolean | undefined; body?: boolean | undefined; } | undefined" - ], - "path": "src/core/server/http/router/validator/validator.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SessionCookieValidationResult", - "type": "Interface", - "tags": [], - "label": "SessionCookieValidationResult", - "description": [ - "\nReturn type from a function to validate cookie contents." - ], - "path": "src/core/server/http/cookie_session_storage.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SessionCookieValidationResult.isValid", - "type": "boolean", - "tags": [], - "label": "isValid", - "description": [ - "\nWhether the cookie is valid or not." - ], - "path": "src/core/server/http/cookie_session_storage.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SessionCookieValidationResult.path", - "type": "string", - "tags": [], - "label": "path", - "description": [ - "\nThe \"Path\" attribute of the cookie; if the cookie is invalid, this is used to clear it." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/http/cookie_session_storage.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SessionStorage", - "type": "Interface", - "tags": [], - "label": "SessionStorage", - "description": [ - "\nProvides an interface to store and retrieve data across requests." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.SessionStorage", - "text": "SessionStorage" - }, - "" - ], - "path": "src/core/server/http/session_storage.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SessionStorage.get", - "type": "Function", - "tags": [], - "label": "get", - "description": [ - "\nRetrieves session value from the session storage." - ], - "signature": [ - "() => Promise" - ], - "path": "src/core/server/http/session_storage.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SessionStorage.set", - "type": "Function", - "tags": [], - "label": "set", - "description": [ - "\nPuts current session value into the session storage." - ], - "signature": [ - "(sessionValue: T) => void" - ], - "path": "src/core/server/http/session_storage.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SessionStorage.set.$1", - "type": "Uncategorized", - "tags": [], - "label": "sessionValue", - "description": [ - "- value to put" - ], - "signature": [ - "T" - ], - "path": "src/core/server/http/session_storage.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SessionStorage.clear", - "type": "Function", - "tags": [], - "label": "clear", - "description": [ - "\nClears current session." - ], - "signature": [ - "() => void" - ], - "path": "src/core/server/http/session_storage.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SessionStorageCookieOptions", - "type": "Interface", - "tags": [], - "label": "SessionStorageCookieOptions", - "description": [ - "\nConfiguration used to create HTTP session storage based on top of cookie mechanism." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.SessionStorageCookieOptions", - "text": "SessionStorageCookieOptions" - }, - "" - ], - "path": "src/core/server/http/cookie_session_storage.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SessionStorageCookieOptions.name", - "type": "string", - "tags": [], - "label": "name", - "description": [ - "\nName of the session cookie." - ], - "path": "src/core/server/http/cookie_session_storage.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SessionStorageCookieOptions.encryptionKey", - "type": "string", - "tags": [], - "label": "encryptionKey", - "description": [ - "\nA key used to encrypt a cookie's value. Should be at least 32 characters long." - ], - "path": "src/core/server/http/cookie_session_storage.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SessionStorageCookieOptions.validate", - "type": "Function", - "tags": [], - "label": "validate", - "description": [ - "\nFunction called to validate a cookie's decrypted value." - ], - "signature": [ - "(sessionValue: T | T[]) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.SessionCookieValidationResult", - "text": "SessionCookieValidationResult" - } - ], - "path": "src/core/server/http/cookie_session_storage.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SessionStorageCookieOptions.validate.$1", - "type": "CompoundType", - "tags": [], - "label": "sessionValue", - "description": [], - "signature": [ - "T | T[]" - ], - "path": "src/core/server/http/cookie_session_storage.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SessionStorageCookieOptions.isSecure", - "type": "boolean", - "tags": [], - "label": "isSecure", - "description": [ - "\nFlag indicating whether the cookie should be sent only via a secure connection." - ], - "path": "src/core/server/http/cookie_session_storage.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SessionStorageCookieOptions.sameSite", - "type": "CompoundType", - "tags": [], - "label": "sameSite", - "description": [ - "\nDefines SameSite attribute of the Set-Cookie Header.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite" - ], - "signature": [ - "\"None\" | \"Strict\" | \"Lax\" | undefined" - ], - "path": "src/core/server/http/cookie_session_storage.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SessionStorageFactory", - "type": "Interface", - "tags": [], - "label": "SessionStorageFactory", - "description": [ - "\nSessionStorage factory to bind one to an incoming request" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.SessionStorageFactory", - "text": "SessionStorageFactory" - }, - "" - ], - "path": "src/core/server/http/session_storage.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SessionStorageFactory.asScoped", - "type": "Function", - "tags": [], - "label": "asScoped", - "description": [], - "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.SessionStorage", - "text": "SessionStorage" - }, - "" - ], - "path": "src/core/server/http/session_storage.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SessionStorageFactory.asScoped.$1", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "path": "src/core/server/http/session_storage.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - } - ], - "enums": [ - { - "parentPluginId": "core", - "id": "def-server.AuthResultType", - "type": "Enum", - "tags": [], - "label": "AuthResultType", - "description": [], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.AuthStatus", - "type": "Enum", - "tags": [], - "label": "AuthStatus", - "description": [ - "\nStatus indicating an outcome of the authentication." - ], - "path": "src/core/server/http/auth_state_storage.ts", - "deprecated": false, - "initialIsOpen": false - } - ], - "misc": [ - { - "parentPluginId": "core", - "id": "def-server.AuthenticationHandler", - "type": "Type", - "tags": [], - "label": "AuthenticationHandler", - "description": [ - "\nSee {@link AuthToolkit}." - ], - "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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; }, 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.AuthResult", - "text": "AuthResult" - }, - " | Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthResult", - "text": "AuthResult" - }, - ">" - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.AuthenticationHandler.$1", - "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.AuthenticationHandler.$2", - "type": "Object", - "tags": [], - "label": "response", - "description": [], - "signature": [ - "{ badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; }" - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.AuthenticationHandler.$3", - "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 - }, - { - "parentPluginId": "core", - "id": "def-server.AuthHeaders", - "type": "Type", - "tags": [], - "label": "AuthHeaders", - "description": [ - "\nAuth Headers map" - ], - "signature": [ - "{ [x: string]: string | string[]; }" - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.AuthResult", - "type": "Type", - "tags": [], - "label": "AuthResult", - "description": [], - "signature": [ - { - "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/lifecycle/auth.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.DestructiveRouteMethod", - "type": "Type", - "tags": [], - "label": "DestructiveRouteMethod", - "description": [ - "\nSet of HTTP methods changing the state of the server." - ], - "signature": [ - "\"delete\" | \"post\" | \"put\" | \"patch\"" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.GetAuthHeaders", - "type": "Type", - "tags": [ - "return" - ], - "label": "GetAuthHeaders", - "description": [ - "\nGet headers to authenticate a user against Elasticsearch." - ], - "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthHeaders", - "text": "AuthHeaders" - }, - " | undefined" - ], - "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.GetAuthHeaders.$1", - "type": "Object", - "tags": [], - "label": "request", - "description": [ - "{@link KibanaRequest } - an incoming request." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "path": "src/core/server/http/auth_headers_storage.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.GetAuthState", - "type": "Type", - "tags": [], - "label": "GetAuthState", - "description": [ - "\nGets authentication state for a request. Returned by `auth` interceptor." - ], - "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ") => { status: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthStatus", - "text": "AuthStatus" - }, - "; state: T; }" - ], - "path": "src/core/server/http/auth_state_storage.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.GetAuthState.$1", - "type": "Object", - "tags": [], - "label": "request", - "description": [ - "{@link KibanaRequest } - an incoming request." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "path": "src/core/server/http/auth_state_storage.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.Headers", - "type": "Type", - "tags": [], - "label": "Headers", - "description": [ - "\nHttp request headers to read." - ], - "signature": [ - "{ warning?: string | string[] | undefined; from?: string | string[] | undefined; date?: string | string[] | undefined; expires?: string | string[] | undefined; range?: string | string[] | undefined; origin?: string | string[] | undefined; location?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; etag?: string | string[] | undefined; expect?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" - ], - "path": "src/core/server/http/router/headers.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpResponsePayload", - "type": "Type", - "tags": [], - "label": "HttpResponsePayload", - "description": [ - "\nData send to the client as a response payload." - ], - "signature": [ - "string | Record | ", - "Stream", - " | Buffer | undefined" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.IBasePath", - "type": "Type", - "tags": [], - "label": "IBasePath", - "description": [ - "\nAccess or manipulate the Kibana base path\n\n{@link BasePath}" - ], - "signature": [ - "{ get: (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ") => string; set: (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", requestSpecificBasePath: string) => void; remove: (path: string) => string; prepend: (path: string) => string; readonly serverBasePath: string; readonly publicBaseUrl?: string | undefined; }" - ], - "path": "src/core/server/http/base_path_service.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.IsAuthenticated", - "type": "Type", - "tags": [], - "label": "IsAuthenticated", - "description": [ - "\nReturns authentication status for a request." - ], - "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ") => boolean" - ], - "path": "src/core/server/http/auth_state_storage.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IsAuthenticated.$1", - "type": "Object", - "tags": [], - "label": "request", - "description": [ - "{@link KibanaRequest } - an incoming request." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "path": "src/core/server/http/auth_state_storage.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequestRouteOptions", - "type": "Type", - "tags": [], - "label": "KibanaRequestRouteOptions", - "description": [ - "\nRoute options: If 'GET' or 'OPTIONS' method, body options won't be returned." - ], - "signature": [ - "Method extends \"options\" | \"get\" ? Required, \"body\">> : Required<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfigOptions", - "text": "RouteConfigOptions" - }, - ">" - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaResponseFactory", - "type": "Type", - "tags": [], - "label": "KibanaResponseFactory", - "description": [ - "\nCreates an object containing request response payload, HTTP headers, error details, and other data transmitted to the client." - ], - "signature": [ - "{ custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | 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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.KnownHeaders", - "type": "Type", - "tags": [], - "label": "KnownHeaders", - "description": [ - "\nSet of well-known HTTP headers." - ], - "signature": [ - "\"warning\" | \"from\" | \"date\" | \"expires\" | \"range\" | \"origin\" | \"location\" | \"allow\" | \"accept\" | \"host\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"etag\" | \"expect\" | \"forwarded\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\"" - ], - "path": "src/core/server/http/router/headers.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.LifecycleResponseFactory", - "type": "Type", - "tags": [], - "label": "LifecycleResponseFactory", - "description": [ - "\nCreates an object containing redirection or error response with error details, HTTP headers, and other data transmitted to the client." - ], - "signature": [ - "{ badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; }" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPostAuthHandler", - "type": "Type", - "tags": [], - "label": "OnPostAuthHandler", - "description": [ - "\nSee {@link OnPostAuthToolkit}." - ], - "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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; }, toolkit: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPostAuthToolkit", - "text": "OnPostAuthToolkit" - }, - ") => ", - "KibanaResponse", - " | Next | Promise<", - "KibanaResponse", - " | Next>" - ], - "path": "src/core/server/http/lifecycle/on_post_auth.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.OnPostAuthHandler.$1", - "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.OnPostAuthHandler.$2", - "type": "Object", - "tags": [], - "label": "response", - "description": [], - "signature": [ - "{ badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; }" - ], - "path": "src/core/server/http/lifecycle/on_post_auth.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPostAuthHandler.$3", - "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 - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreAuthHandler", - "type": "Type", - "tags": [], - "label": "OnPreAuthHandler", - "description": [ - "\nSee {@link OnPreAuthToolkit}." - ], - "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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; }, toolkit: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreAuthToolkit", - "text": "OnPreAuthToolkit" - }, - ") => Next | ", - "KibanaResponse", - " | Promise>" - ], - "path": "src/core/server/http/lifecycle/on_pre_auth.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.OnPreAuthHandler.$1", - "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.OnPreAuthHandler.$2", - "type": "Object", - "tags": [], - "label": "response", - "description": [], - "signature": [ - "{ badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; }" - ], - "path": "src/core/server/http/lifecycle/on_pre_auth.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreAuthHandler.$3", - "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 - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreResponseHandler", - "type": "Type", - "tags": [], - "label": "OnPreResponseHandler", - "description": [ - "\nSee {@link OnPreRoutingToolkit}." - ], - "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" - }, - ") => OnPreResponseResult | Promise" - ], - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.OnPreResponseHandler.$1", - "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.OnPreResponseHandler.$2", - "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.OnPreResponseHandler.$3", - "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 - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreRoutingHandler", - "type": "Type", - "tags": [], - "label": "OnPreRoutingHandler", - "description": [ - "\nSee {@link OnPreRoutingToolkit}." - ], - "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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; }, toolkit: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreRoutingToolkit", - "text": "OnPreRoutingToolkit" - }, - ") => ", - "KibanaResponse", - " | OnPreRoutingResult | Promise<", - "KibanaResponse", - " | OnPreRoutingResult>" - ], - "path": "src/core/server/http/lifecycle/on_pre_routing.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.OnPreRoutingHandler.$1", - "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.OnPreRoutingHandler.$2", - "type": "Object", - "tags": [], - "label": "response", - "description": [], - "signature": [ - "{ badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; }" - ], - "path": "src/core/server/http/lifecycle/on_pre_routing.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreRoutingHandler.$3", - "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 - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RedirectResponseOptions", - "type": "Type", - "tags": [], - "label": "RedirectResponseOptions", - "description": [ - "\nHTTP response parameters for redirection response" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - " & { headers: { location: string; }; }" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RequestHandler", - "type": "Type", - "tags": [], - "label": "RequestHandler", - "description": [ - "\nA function executed when route path matched requested resource path.\nRequest handler is expected to return a result of one of {@link KibanaResponseFactory} functions.\nIf anything else is returned, or an error is thrown, the HTTP service will automatically log the error\nand respond `500 - Internal Server Error`." - ], - "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.RequestHandler.$1", - "type": "Uncategorized", - "tags": [], - "label": "context", - "description": [ - "{@link RequestHandlerContext } - the core context exposed for this request." - ], - "signature": [ - "Context" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RequestHandler.$2", - "type": "Object", - "tags": [], - "label": "request", - "description": [ - "{@link KibanaRequest } - object containing information about requested resource,\nsuch as path, method, headers, parameters, query, body, etc." - ], - "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.RequestHandler.$3", - "type": "Uncategorized", - "tags": [], - "label": "response", - "description": [ - "{@link KibanaResponseFactory } - a set of helper functions used to respond to a request." - ], - "signature": [ - "ResponseFactory" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RequestHandlerContextContainer", - "type": "Type", - "tags": [], - "label": "RequestHandlerContextContainer", - "description": [ - "\nAn object that handles registration of http request context providers." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IContextContainer", - "text": "IContextContainer" - } - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RequestHandlerContextProvider", - "type": "Type", - "tags": [], - "label": "RequestHandlerContextProvider", - "description": [ - "\nContext provider for request handler.\nExtends request context object with provided functionality or data.\n" - ], - "signature": [ - "(context: Omit, request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: { custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | 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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }) => ", - "MaybePromise", - ">" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RequestHandlerContextProvider.$1", - "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.RequestHandlerContextProvider.$2", - "type": "Object", - "tags": [], - "label": "rest", - "description": [], - "signature": [ - "[request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: { custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | 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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; 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 - }, - { - "parentPluginId": "core", - "id": "def-server.RequestHandlerWrapper", - "type": "Type", - "tags": [], - "label": "RequestHandlerWrapper", - "description": [ - "\nType-safe wrapper for {@link RequestHandler} function." - ], - "signature": [ - " | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | 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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; } = { custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | 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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }>(handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RequestHandler", - "text": "RequestHandler" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RequestHandler", - "text": "RequestHandler" - }, - "" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RequestHandlerWrapper.$1", - "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.RequestHandlerWrapper.$1.$1", - "type": "Uncategorized", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "Context" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RequestHandlerWrapper.$1.$2", - "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.RequestHandlerWrapper.$1.$3", - "type": "Uncategorized", - "tags": [], - "label": "response", - "description": [], - "signature": [ - "ResponseFactory" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - } - ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.ResponseError", - "type": "Type", - "tags": [], - "label": "ResponseError", - "description": [ - "\nError message and optional data send to the client in case of error." - ], - "signature": [ - "string | Error | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; }" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.ResponseErrorAttributes", - "type": "Type", - "tags": [], - "label": "ResponseErrorAttributes", - "description": [ - "\nAdditional data to provide error details." - ], - "signature": [ - "{ [x: string]: any; }" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.ResponseHeaders", - "type": "Type", - "tags": [], - "label": "ResponseHeaders", - "description": [ - "\nHttp response headers to set." - ], - "signature": [ - "Record<\"warning\" | \"from\" | \"date\" | \"expires\" | \"range\" | \"origin\" | \"location\" | \"allow\" | \"accept\" | \"host\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"etag\" | \"expect\" | \"forwarded\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]> | Record" - ], - "path": "src/core/server/http/router/headers.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteContentType", - "type": "Type", - "tags": [], - "label": "RouteContentType", - "description": [ - "\nThe set of supported parseable Content-Types" - ], - "signature": [ - "\"application/json\" | \"multipart/form-data\" | \"application/*+json\" | \"application/octet-stream\" | \"application/x-www-form-urlencoded\" | \"text/*\"" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteMethod", - "type": "Type", - "tags": [], - "label": "RouteMethod", - "description": [ - "\nThe set of common HTTP methods supported by Kibana routing." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.SafeRouteMethod", - "text": "SafeRouteMethod" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.DestructiveRouteMethod", - "text": "DestructiveRouteMethod" - } - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteRegistrar", - "type": "Type", - "tags": [], - "label": "RouteRegistrar", - "description": [ - "\nRoute handler common definition\n" - ], - "signature": [ - "(route: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfig", - "text": "RouteConfig" - }, - ", handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RequestHandler", - "text": "RequestHandler" - }, - " | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | 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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }>) => void" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RouteRegistrar.$1", - "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.RouteRegistrar.$2", - "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 | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | 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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; 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.RouteRegistrar.$2.$1", - "type": "Uncategorized", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "Context" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteRegistrar.$2.$2", - "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.RouteRegistrar.$2.$3", - "type": "Uncategorized", - "tags": [], - "label": "response", - "description": [], - "signature": [ - "ResponseFactory" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - } - ] - } - ], - "initialIsOpen": false - }, + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [ { "parentPluginId": "core", - "id": "def-server.RouteValidationFunction", - "type": "Type", + "id": "def-server.CspConfig", + "type": "Class", "tags": [], - "label": "RouteValidationFunction", + "label": "CspConfig", "description": [ - "\nThe custom validation function if @kbn/config-schema is not a valid solution for your specific plugin requirements.\n" + "\nCSP configuration for use in Kibana." ], "signature": [ - "(data: any, validationResult: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidationResultFactory", - "text": "RouteValidationResultFactory" - }, - ") => { value: T; error?: undefined; } | { value?: undefined; error: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidationError", - "text": "RouteValidationError" + "section": "def-server.CspConfig", + "text": "CspConfig" }, - "; }" + " implements ", + "ICspConfig" ], - "path": "src/core/server/http/router/validator/validator.ts", + "path": "src/core/server/http/csp/csp_config.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.RouteValidationFunction.$1", - "type": "Any", + "id": "def-server.CspConfig.DEFAULT", + "type": "Object", "tags": [], - "label": "data", + "label": "DEFAULT", "description": [], "signature": [ - "any" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CspConfig", + "text": "CspConfig" + } ], - "path": "src/core/server/http/router/validator/validator.ts", + "path": "src/core/server/http/csp/csp_config.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.RouteValidationFunction.$2", + "id": "def-server.CspConfig.directives", "type": "Object", "tags": [], - "label": "validationResult", + "label": "#directives", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidationResultFactory", - "text": "RouteValidationResultFactory" - } + "CspDirectives" ], - "path": "src/core/server/http/router/validator/validator.ts", + "path": "src/core/server/http/csp/csp_config.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteValidationSpec", - "type": "Type", - "tags": [], - "label": "RouteValidationSpec", - "description": [ - "\nAllowed property validation options: either @kbn/config-schema validations or custom validation functions\n\nSee {@link RouteValidationFunction} for custom validation.\n" - ], - "signature": [ - "ObjectType", - " | ", - "Type", - " | ", + }, { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidationFunction", - "text": "RouteValidationFunction" + "parentPluginId": "core", + "id": "def-server.CspConfig.strict", + "type": "boolean", + "tags": [], + "label": "strict", + "description": [], + "path": "src/core/server/http/csp/csp_config.ts", + "deprecated": false }, - "" - ], - "path": "src/core/server/http/router/validator/validator.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteValidatorFullConfig", - "type": "Type", - "tags": [], - "label": "RouteValidatorFullConfig", - "description": [ - "\nRoute validations config and options merged into one object" - ], - "signature": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidatorConfig", - "text": "RouteValidatorConfig" + "parentPluginId": "core", + "id": "def-server.CspConfig.warnLegacyBrowsers", + "type": "boolean", + "tags": [], + "label": "warnLegacyBrowsers", + "description": [], + "path": "src/core/server/http/csp/csp_config.ts", + "deprecated": false }, - " & ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidatorOptions", - "text": "RouteValidatorOptions" + "parentPluginId": "core", + "id": "def-server.CspConfig.disableEmbedding", + "type": "boolean", + "tags": [], + "label": "disableEmbedding", + "description": [], + "path": "src/core/server/http/csp/csp_config.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CspConfig.header", + "type": "string", + "tags": [], + "label": "header", + "description": [], + "path": "src/core/server/http/csp/csp_config.ts", + "deprecated": false } ], - "path": "src/core/server/http/router/validator/validator.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SafeRouteMethod", - "type": "Type", - "tags": [], - "label": "SafeRouteMethod", - "description": [ - "\nSet of HTTP methods not changing the state of the server." - ], - "signature": [ - "\"options\" | \"get\"" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false, "initialIsOpen": false } ], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], "objects": [ { "parentPluginId": "core", @@ -13179,9 +120,7 @@ "type": "Object", "tags": [], "label": "kibanaResponseFactory", - "description": [ - "\nSet of helpers used to create `KibanaResponse` to form HTTP response on an incoming request.\nShould be returned as a result of {@link RequestHandler} execution.\n" - ], + "description": [], "path": "src/core/server/http/router/response.ts", "deprecated": false, "children": [ @@ -13230,28 +169,14 @@ "type": "Function", "tags": [], "label": "custom", - "description": [ - "/**\n * Creates a response with defined status code and payload.\n * @param options - {@link CustomHttpResponseOptions} configures HTTP response parameters.\n */" - ], + "description": [], "signature": [ " | Error | ", "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, + " | Buffer | { message: string | Error; attributes?: ", + "ResponseErrorAttributes", + " | undefined; } | undefined>(options: ", + "CustomHttpResponseOptions", ") => ", "KibanaResponse", "" @@ -13267,13 +192,7 @@ "label": "options", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, + "CustomHttpResponseOptions", "" ], "path": "src/core/server/http/router/response.ts", @@ -13285,22 +204,6 @@ } ], "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.validBodyOutput", - "type": "Object", - "tags": [], - "label": "validBodyOutput", - "description": [ - "\nThe set of valid body.output" - ], - "signature": [ - "readonly [\"data\", \"stream\"]" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false, - "initialIsOpen": false } ] }, diff --git a/api_docs/core_http.mdx b/api_docs/core_http.mdx index fb861e104213e..3dca29910f474 100644 --- a/api_docs/core_http.mdx +++ b/api_docs/core_http.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-http title: "core.http" image: https://source.unsplash.com/400x175/?github summary: API docs for the core.http plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.http'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,15 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2506 | 14 | 887 | 27 | - -## Client - -### Interfaces - - -### Consts, variables and types - +| 2489 | 9 | 746 | 25 | ## Server @@ -36,12 +28,3 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que ### Classes -### Interfaces - - -### Enums - - -### Consts, variables and types - - diff --git a/api_docs/core_saved_objects.devdocs.json b/api_docs/core_saved_objects.devdocs.json index 7077e7a0cde87..7f4ef1cc15a30 100644 --- a/api_docs/core_saved_objects.devdocs.json +++ b/api_docs/core_saved_objects.devdocs.json @@ -7808,13 +7808,7 @@ "The http request initiating the export." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "src/core/server/saved_objects/export/types.ts", @@ -9219,13 +9213,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", @@ -10045,13 +10033,7 @@ "\nThe request that initiated the export request. Can be used to create scoped\nservices or client inside the {@link SavedObjectsExportTransform | transformation}" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "src/core/server/saved_objects/export/types.ts", @@ -12101,13 +12083,7 @@ ], "signature": [ "(req: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ", includedHiddenTypes?: string[] | undefined) => ", { "pluginId": "core", @@ -12128,13 +12104,7 @@ "label": "req", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "src/core/server/saved_objects/saved_objects_service.ts", @@ -13144,13 +13114,7 @@ ], "signature": [ "(req: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ", options?: ", { "pluginId": "core", @@ -13179,13 +13143,7 @@ "label": "req", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "src/core/server/saved_objects/saved_objects_service.ts", @@ -13227,13 +13185,7 @@ ], "signature": [ "(req: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ", includedHiddenTypes?: string[] | undefined) => ", { "pluginId": "core", @@ -13256,13 +13208,7 @@ "- The request to create the scoped repository from." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "src/core/server/saved_objects/saved_objects_service.ts", @@ -15333,13 +15279,7 @@ ], "signature": [ "({ request, includedHiddenTypes, }: { request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "; includedHiddenTypes?: string[] | undefined; }) => ", { "pluginId": "core", @@ -15362,13 +15302,7 @@ "description": [], "signature": [ "{ request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "; includedHiddenTypes?: string[] | undefined; }" ], "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", diff --git a/api_docs/core_saved_objects.mdx b/api_docs/core_saved_objects.mdx index 72f08b916c800..ef05af39d188d 100644 --- a/api_docs/core_saved_objects.mdx +++ b/api_docs/core_saved_objects.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-savedObjects title: "core.savedObjects" image: https://source.unsplash.com/400x175/?github summary: API docs for the core.savedObjects plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.savedObjects'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2506 | 14 | 887 | 27 | +| 2489 | 9 | 746 | 25 | ## Client diff --git a/api_docs/custom_integrations.devdocs.json b/api_docs/custom_integrations.devdocs.json index 45583241f465a..a56430796e324 100644 --- a/api_docs/custom_integrations.devdocs.json +++ b/api_docs/custom_integrations.devdocs.json @@ -400,7 +400,7 @@ "label": "categories", "description": [], "signature": [ - "(\"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\")[]" + "(\"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"threat_intel\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\")[]" ], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false @@ -447,7 +447,7 @@ "\nA category applicable to an Integration." ], "signature": [ - "\"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\"" + "\"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"threat_intel\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\"" ], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, @@ -672,7 +672,7 @@ "label": "categories", "description": [], "signature": [ - "(\"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\")[]" + "(\"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"threat_intel\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\")[]" ], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false @@ -774,7 +774,7 @@ "label": "id", "description": [], "signature": [ - "\"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\"" + "\"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"threat_intel\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\"" ], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false @@ -795,7 +795,7 @@ "\nThe list of all available categories." ], "signature": [ - "(\"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\")[]" + "(\"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"threat_intel\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\")[]" ], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, @@ -811,7 +811,7 @@ "\nA category applicable to an Integration." ], "signature": [ - "\"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\"" + "\"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"threat_intel\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\"" ], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, @@ -1133,6 +1133,16 @@ "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.threat_intel", + "type": "string", + "tags": [], + "label": "threat_intel", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false + }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.ticketing", diff --git a/api_docs/custom_integrations.mdx b/api_docs/custom_integrations.mdx index baeee2c555ff2..ee0b3ef00b9be 100644 --- a/api_docs/custom_integrations.mdx +++ b/api_docs/custom_integrations.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/customIntegrations title: "customIntegrations" image: https://source.unsplash.com/400x175/?github summary: API docs for the customIntegrations plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Fleet](https://github.com/orgs/elastic/teams/fleet) for questions regar | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 101 | 0 | 82 | 1 | +| 102 | 0 | 83 | 1 | ## Client diff --git a/api_docs/dashboard.mdx b/api_docs/dashboard.mdx index c0aa8b78de0f2..17a5f089230cd 100644 --- a/api_docs/dashboard.mdx +++ b/api_docs/dashboard.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dashboard title: "dashboard" image: https://source.unsplash.com/400x175/?github summary: API docs for the dashboard plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/dashboard_enhanced.mdx b/api_docs/dashboard_enhanced.mdx index 3dd4fd0da368c..cb8a65c67c0e3 100644 --- a/api_docs/dashboard_enhanced.mdx +++ b/api_docs/dashboard_enhanced.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dashboardEnhanced title: "dashboardEnhanced" image: https://source.unsplash.com/400x175/?github summary: API docs for the dashboardEnhanced plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data.devdocs.json b/api_docs/data.devdocs.json index 37616aad58f02..cc89249f62a1b 100644 --- a/api_docs/data.devdocs.json +++ b/api_docs/data.devdocs.json @@ -7067,13 +7067,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "src/plugins/data/public/types.ts", "deprecated": false @@ -14733,13 +14727,7 @@ "text": "ElasticsearchClient" }, ", request?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", " | undefined, byPassCapabilities?: boolean | undefined) => Promise<", { "pluginId": "dataViews", @@ -16300,13 +16288,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", " | undefined" ], "path": "src/plugins/data_views/server/types.ts", diff --git a/api_docs/data.mdx b/api_docs/data.mdx index fbc3fbb0d8cb3..f6c01d22f9c87 100644 --- a/api_docs/data.mdx +++ b/api_docs/data.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/data title: "data" image: https://source.unsplash.com/400x175/?github summary: API docs for the data plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data_query.devdocs.json b/api_docs/data_query.devdocs.json index 53a88b9a47a48..a061d52a3ae43 100644 --- a/api_docs/data_query.devdocs.json +++ b/api_docs/data_query.devdocs.json @@ -1164,13 +1164,7 @@ "description": [], "signature": [ "(http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", ") => { createQuery: (attributes: ", { "pluginId": "data", @@ -1240,13 +1234,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "src/plugins/data/public/query/saved_query/saved_query_service.ts", "deprecated": false, diff --git a/api_docs/data_query.mdx b/api_docs/data_query.mdx index 9827310477396..50c49ba0251eb 100644 --- a/api_docs/data_query.mdx +++ b/api_docs/data_query.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/data-query title: "data.query" image: https://source.unsplash.com/400x175/?github summary: API docs for the data.query plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data_search.devdocs.json b/api_docs/data_search.devdocs.json index 6232f70b6be2a..a406c0bcb8d3f 100644 --- a/api_docs/data_search.devdocs.json +++ b/api_docs/data_search.devdocs.json @@ -2460,13 +2460,7 @@ "text": "CoreStart" }, ") => (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => { getId: (args_0: ", { "pluginId": "data", @@ -3044,13 +3038,7 @@ "text": "CoreStart" }, ") => (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", "IScopedSearchSessionsClient", "" @@ -3784,13 +3772,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "src/plugins/data/server/search/types.ts", @@ -13147,13 +13129,7 @@ "description": [], "signature": [ "(getStartDependencies: (getKibanaRequest: (() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") | undefined) => Promise<", { "pluginId": "data", @@ -13183,13 +13159,7 @@ "description": [], "signature": [ "(getKibanaRequest: (() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") | undefined) => Promise<", { "pluginId": "data", diff --git a/api_docs/data_search.mdx b/api_docs/data_search.mdx index 3c16a3c8278de..b141bc3f7fa82 100644 --- a/api_docs/data_search.mdx +++ b/api_docs/data_search.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/data-search title: "data.search" image: https://source.unsplash.com/400x175/?github summary: API docs for the data.search plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data_view_editor.mdx b/api_docs/data_view_editor.mdx index 4ae2900de37e9..a0dfcb172f2c8 100644 --- a/api_docs/data_view_editor.mdx +++ b/api_docs/data_view_editor.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViewEditor title: "dataViewEditor" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataViewEditor plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewEditor'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data_view_field_editor.mdx b/api_docs/data_view_field_editor.mdx index 97304ba2cdf8a..59bf59eefe9bd 100644 --- a/api_docs/data_view_field_editor.mdx +++ b/api_docs/data_view_field_editor.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViewFieldEditor title: "dataViewFieldEditor" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataViewFieldEditor plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewFieldEditor'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data_view_management.mdx b/api_docs/data_view_management.mdx index 86b1d8f37a0ca..d1f57d8a709de 100644 --- a/api_docs/data_view_management.mdx +++ b/api_docs/data_view_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViewManagement title: "dataViewManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataViewManagement plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data_views.devdocs.json b/api_docs/data_views.devdocs.json index 79dfb2be14325..1182fdba14c4d 100644 --- a/api_docs/data_views.devdocs.json +++ b/api_docs/data_views.devdocs.json @@ -2241,13 +2241,7 @@ "http dependency" ], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "src/plugins/data_views/public/data_views/data_views_api_client.ts", "deprecated": false, @@ -7892,13 +7886,7 @@ "text": "ElasticsearchClient" }, ", request?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", " | undefined, byPassCapabilities?: boolean | undefined) => Promise<", { "pluginId": "dataViews", @@ -9401,13 +9389,7 @@ "text": "ElasticsearchClient" }, ", request?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", " | undefined, byPassCapabilities?: boolean | undefined) => Promise<", { "pluginId": "dataViews", @@ -10525,13 +10507,7 @@ "text": "ElasticsearchClient" }, ", request?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", " | undefined, byPassCapabilities?: boolean | undefined) => Promise<", { "pluginId": "dataViews", @@ -12092,13 +12068,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", " | undefined" ], "path": "src/plugins/data_views/server/types.ts", diff --git a/api_docs/data_views.mdx b/api_docs/data_views.mdx index c746fe7b7400d..affa6f0e564e2 100644 --- a/api_docs/data_views.mdx +++ b/api_docs/data_views.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViews title: "dataViews" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataViews plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data_visualizer.mdx b/api_docs/data_visualizer.mdx index f1099aefee61c..7c3260f17f381 100644 --- a/api_docs/data_visualizer.mdx +++ b/api_docs/data_visualizer.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataVisualizer title: "dataVisualizer" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataVisualizer plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/deprecations_by_api.mdx b/api_docs/deprecations_by_api.mdx index 864a82a0d93ec..671d479bbccc2 100644 --- a/api_docs/deprecations_by_api.mdx +++ b/api_docs/deprecations_by_api.mdx @@ -3,7 +3,7 @@ id: kibDevDocsDeprecationsByApi slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-api title: Deprecated API usage by API summary: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by. -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. --- @@ -81,7 +81,11 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | security, fleet | 8.8.0 | | | security | 8.8.0 | | | mapsEms | 8.8.0 | -| | ml | 8.8.0 +| | ml, @kbn/core-http-browser-internal | 8.8.0 + +Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block, +so TS and code-reference navigation might not highlight them. | +| | @kbn/core-http-browser-internal | 8.8.0 Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block, so TS and code-reference navigation might not highlight them. | @@ -128,8 +132,9 @@ Safe to remove. | | reporting | | | reporting | | | taskManager | -| | core | | | core | | | core | +| | @kbn/core-http-browser | +| | @kbn/core-http-browser | | | @kbn/core-injected-metadata-browser | | | @kbn/core-injected-metadata-browser | \ No newline at end of file diff --git a/api_docs/deprecations_by_plugin.mdx b/api_docs/deprecations_by_plugin.mdx index 86dc108ed9be8..fab0384a628df 100644 --- a/api_docs/deprecations_by_plugin.mdx +++ b/api_docs/deprecations_by_plugin.mdx @@ -3,12 +3,27 @@ id: kibDevDocsDeprecationsByPlugin slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-plugin title: Deprecated API usage by plugin summary: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by. -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. --- +## @kbn/core-http-browser-internal + +| Deprecated API | Reference location(s) | Remove By | +| ---------------|-----------|-----------| +| | [http_fetch_error.ts](https://github.com/elastic/kibana/tree/master/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts#:~:text=req), [http_fetch_error.ts](https://github.com/elastic/kibana/tree/master/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts#:~:text=req) | 8.8.0 + +Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block, +so TS and code-reference navigation might not highlight them. | +| | [http_fetch_error.ts](https://github.com/elastic/kibana/tree/master/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts#:~:text=res), [http_fetch_error.ts](https://github.com/elastic/kibana/tree/master/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts#:~:text=res) | 8.8.0 + +Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block, +so TS and code-reference navigation might not highlight them. | + + + ## actions | Deprecated API | Reference location(s) | Remove By | diff --git a/api_docs/deprecations_by_team.mdx b/api_docs/deprecations_by_team.mdx index 9f5673c2d61a3..8d5fe5e1eae5d 100644 --- a/api_docs/deprecations_by_team.mdx +++ b/api_docs/deprecations_by_team.mdx @@ -3,7 +3,7 @@ id: kibDevDocsDeprecationsDueByTeam slug: /kibana-dev-docs/api-meta/deprecations-due-by-team title: Deprecated APIs due to be removed, by team summary: Lists the teams that are referencing deprecated APIs with a remove by date. -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. --- @@ -186,4 +186,19 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | --------|-------|-----------|-----------| | visualizations | | [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject) | 8.8.0 | | visualizations | | [visualize_top_nav.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx#:~:text=onAppLeave), [visualize_editor_common.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_editor_common.tsx#:~:text=onAppLeave), [app.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/app.tsx#:~:text=onAppLeave), [index.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/index.tsx#:~:text=onAppLeave), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [mounter.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/mounter.tsx#:~:text=onAppLeave) | 8.8.0 | -| management | | [application.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/management/public/application.tsx#:~:text=appBasePath) | 8.8.0 | \ No newline at end of file +| management | | [application.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/management/public/application.tsx#:~:text=appBasePath) | 8.8.0 | + + + +## [Owner missing] + +| Plugin | Deprecated API | Reference location(s) | Remove By | +| --------|-------|-----------|-----------| +| @kbn/core-http-browser-internal | | [http_fetch_error.ts](https://github.com/elastic/kibana/tree/master/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts#:~:text=req), [http_fetch_error.ts](https://github.com/elastic/kibana/tree/master/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts#:~:text=req) | 8.8.0 + +Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block, +so TS and code-reference navigation might not highlight them. | +| @kbn/core-http-browser-internal | | [http_fetch_error.ts](https://github.com/elastic/kibana/tree/master/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts#:~:text=res), [http_fetch_error.ts](https://github.com/elastic/kibana/tree/master/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts#:~:text=res) | 8.8.0 + +Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block, +so TS and code-reference navigation might not highlight them. | \ No newline at end of file diff --git a/api_docs/dev_tools.mdx b/api_docs/dev_tools.mdx index f16f4311b822f..aa54cbe4f050e 100644 --- a/api_docs/dev_tools.mdx +++ b/api_docs/dev_tools.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/devTools title: "devTools" image: https://source.unsplash.com/400x175/?github summary: API docs for the devTools plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/discover.mdx b/api_docs/discover.mdx index 65fbcba576479..f65c671bed195 100644 --- a/api_docs/discover.mdx +++ b/api_docs/discover.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/discover title: "discover" image: https://source.unsplash.com/400x175/?github summary: API docs for the discover plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/discover_enhanced.mdx b/api_docs/discover_enhanced.mdx index 927048b3341b7..0e9c5ec48c255 100644 --- a/api_docs/discover_enhanced.mdx +++ b/api_docs/discover_enhanced.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/discoverEnhanced title: "discoverEnhanced" image: https://source.unsplash.com/400x175/?github summary: API docs for the discoverEnhanced plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/elastic_apm_synthtrace.mdx b/api_docs/elastic_apm_synthtrace.mdx index 5c1b30101fb48..5ca22a26a6e36 100644 --- a/api_docs/elastic_apm_synthtrace.mdx +++ b/api_docs/elastic_apm_synthtrace.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/elastic-apm-synthtrace title: "@elastic/apm-synthtrace" image: https://source.unsplash.com/400x175/?github summary: API docs for the @elastic/apm-synthtrace plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@elastic/apm-synthtrace'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/embeddable.devdocs.json b/api_docs/embeddable.devdocs.json index c04fd527e5e5f..80b1999d682a5 100644 --- a/api_docs/embeddable.devdocs.json +++ b/api_docs/embeddable.devdocs.json @@ -2513,6 +2513,21 @@ ], "returnComment": [] }, + { + "parentPluginId": "embeddable", + "id": "def-public.Embeddable.reportsEmbeddableLoad", + "type": "Function", + "tags": [], + "label": "reportsEmbeddableLoad", + "description": [], + "signature": [ + "() => boolean" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "deprecated": false, + "children": [], + "returnComment": [] + }, { "parentPluginId": "embeddable", "id": "def-public.Embeddable.refreshInputFromParent", @@ -6200,6 +6215,50 @@ "deprecated": false } ] + }, + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddableChildPanelProps.onPanelStatusChange", + "type": "Function", + "tags": [], + "label": "onPanelStatusChange", + "description": [], + "signature": [ + "((info: ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddablePhaseEvent", + "text": "EmbeddablePhaseEvent" + }, + ") => void) | undefined" + ], + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddableChildPanelProps.onPanelStatusChange.$1", + "type": "Object", + "tags": [], + "label": "info", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddablePhaseEvent", + "text": "EmbeddablePhaseEvent" + } + ], + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -6917,6 +6976,19 @@ "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "deprecated": false }, + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddableOutput.rendered", + "type": "CompoundType", + "tags": [], + "label": "rendered", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "deprecated": false + }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableOutput.error", @@ -7116,6 +7188,72 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddablePhaseEvent", + "type": "Interface", + "tags": [], + "label": "EmbeddablePhaseEvent", + "description": [], + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddablePhaseEvent.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "deprecated": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddablePhaseEvent.status", + "type": "CompoundType", + "tags": [], + "label": "status", + "description": [], + "signature": [ + "\"loading\" | \"error\" | \"loaded\" | \"rendered\"" + ], + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "deprecated": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddablePhaseEvent.error", + "type": "CompoundType", + "tags": [], + "label": "error", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ErrorLike", + "text": "ErrorLike" + }, + " | undefined" + ], + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "deprecated": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddablePhaseEvent.timeToEvent", + "type": "number", + "tags": [], + "label": "timeToEvent", + "description": [], + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableSetupDependencies", @@ -8082,6 +8220,23 @@ "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", "deprecated": false }, + { + "parentPluginId": "embeddable", + "id": "def-public.IEmbeddable.reportsEmbeddableLoad", + "type": "Function", + "tags": [], + "label": "reportsEmbeddableLoad", + "description": [ + "\nThis method returns false by default.\nIt should be set to true for any embeddable type that utilizes the `loading` and `rendered`\noutput variables to notify a container of their loading progress. If set to false, a container should assume\nthe embeddable is loaded immediately." + ], + "signature": [ + "() => boolean" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, { "parentPluginId": "embeddable", "id": "def-public.IEmbeddable.getIsContainer", @@ -9197,6 +9352,20 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddablePhase", + "type": "Type", + "tags": [], + "label": "EmbeddablePhase", + "description": [], + "signature": [ + "\"loading\" | \"error\" | \"loaded\" | \"rendered\"" + ], + "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableRendererProps", diff --git a/api_docs/embeddable.mdx b/api_docs/embeddable.mdx index 5f00d406d857f..e4131ab27841b 100644 --- a/api_docs/embeddable.mdx +++ b/api_docs/embeddable.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/embeddable title: "embeddable" image: https://source.unsplash.com/400x175/?github summary: API docs for the embeddable plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 494 | 0 | 403 | 3 | +| 505 | 0 | 413 | 3 | ## Client diff --git a/api_docs/embeddable_enhanced.mdx b/api_docs/embeddable_enhanced.mdx index 75016bb8522d3..57a314069ec80 100644 --- a/api_docs/embeddable_enhanced.mdx +++ b/api_docs/embeddable_enhanced.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/embeddableEnhanced title: "embeddableEnhanced" image: https://source.unsplash.com/400x175/?github summary: API docs for the embeddableEnhanced plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableEnhanced'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/encrypted_saved_objects.mdx b/api_docs/encrypted_saved_objects.mdx index 6bc9c1b2fff3b..6d81ac8710d6d 100644 --- a/api_docs/encrypted_saved_objects.mdx +++ b/api_docs/encrypted_saved_objects.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/encryptedSavedObjects title: "encryptedSavedObjects" image: https://source.unsplash.com/400x175/?github summary: API docs for the encryptedSavedObjects plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/enterprise_search.devdocs.json b/api_docs/enterprise_search.devdocs.json index fdbc357cfd7a5..18f9b884e77d7 100644 --- a/api_docs/enterprise_search.devdocs.json +++ b/api_docs/enterprise_search.devdocs.json @@ -41,6 +41,34 @@ "path": "x-pack/plugins/enterprise_search/server/index.ts", "deprecated": false, "initialIsOpen": false + }, + { + "parentPluginId": "enterpriseSearch", + "id": "def-server.CONNECTORS_JOBS_INDEX", + "type": "string", + "tags": [], + "label": "CONNECTORS_JOBS_INDEX", + "description": [], + "signature": [ + "\".elastic-connectors-sync-jobs\"" + ], + "path": "x-pack/plugins/enterprise_search/server/index.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "enterpriseSearch", + "id": "def-server.CONNECTORS_VERSION", + "type": "string", + "tags": [], + "label": "CONNECTORS_VERSION", + "description": [], + "signature": [ + "\"1\"" + ], + "path": "x-pack/plugins/enterprise_search/server/index.ts", + "deprecated": false, + "initialIsOpen": false } ], "objects": [ diff --git a/api_docs/enterprise_search.mdx b/api_docs/enterprise_search.mdx index f386cfae1e269..e63cd6c903d56 100644 --- a/api_docs/enterprise_search.mdx +++ b/api_docs/enterprise_search.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/enterpriseSearch title: "enterpriseSearch" image: https://source.unsplash.com/400x175/?github summary: API docs for the enterpriseSearch plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Enterprise Search](https://github.com/orgs/elastic/teams/enterprise-sea | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 3 | 0 | 3 | 0 | +| 5 | 0 | 5 | 0 | ## Server diff --git a/api_docs/es_ui_shared.devdocs.json b/api_docs/es_ui_shared.devdocs.json index b173688f2c996..4202f9a4377f9 100644 --- a/api_docs/es_ui_shared.devdocs.json +++ b/api_docs/es_ui_shared.devdocs.json @@ -530,13 +530,7 @@ "description": [], "signature": [ "(httpClient: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", ", { path, method, body, query, asSystemRequest }: ", { "pluginId": "esUiShared", @@ -566,13 +560,7 @@ "label": "httpClient", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "src/plugins/es_ui_shared/public/request/send_request.ts", "deprecated": false, @@ -628,13 +616,7 @@ "description": [], "signature": [ "(httpClient: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", ", { path, method, query, body, pollIntervalMs, initialData, deserializer }: ", { "pluginId": "esUiShared", @@ -664,13 +646,7 @@ "label": "httpClient", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "src/plugins/es_ui_shared/public/request/use_request.ts", "deprecated": false, @@ -1252,13 +1228,7 @@ "label": "query", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpFetchQuery", - "text": "HttpFetchQuery" - }, + "HttpFetchQuery", " | undefined" ], "path": "src/plugins/es_ui_shared/public/request/send_request.ts", @@ -1719,13 +1689,7 @@ ], "signature": [ "({ error, response, handleCustomError, }: EsErrorHandlerParams) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, + "IKibanaResponse", "" ], "path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/handle_es_error.ts", diff --git a/api_docs/es_ui_shared.mdx b/api_docs/es_ui_shared.mdx index 5a25ca54bfa5e..9af8efc8273f8 100644 --- a/api_docs/es_ui_shared.mdx +++ b/api_docs/es_ui_shared.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/esUiShared title: "esUiShared" image: https://source.unsplash.com/400x175/?github summary: API docs for the esUiShared plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/event_annotation.mdx b/api_docs/event_annotation.mdx index fa80082909281..ef1af364265bd 100644 --- a/api_docs/event_annotation.mdx +++ b/api_docs/event_annotation.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/eventAnnotation title: "eventAnnotation" image: https://source.unsplash.com/400x175/?github summary: API docs for the eventAnnotation plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/event_log.devdocs.json b/api_docs/event_log.devdocs.json index 9474154ebe004..ee1604a8fa4a6 100644 --- a/api_docs/event_log.devdocs.json +++ b/api_docs/event_log.devdocs.json @@ -1459,13 +1459,7 @@ "description": [], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", { "pluginId": "eventLog", @@ -1486,13 +1480,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/event_log/server/types.ts", diff --git a/api_docs/event_log.mdx b/api_docs/event_log.mdx index 2c6fe10f187c1..8f4e382d5481b 100644 --- a/api_docs/event_log.mdx +++ b/api_docs/event_log.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/eventLog title: "eventLog" image: https://source.unsplash.com/400x175/?github summary: API docs for the eventLog plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_error.mdx b/api_docs/expression_error.mdx index 7206bfc8a7261..51094be114475 100644 --- a/api_docs/expression_error.mdx +++ b/api_docs/expression_error.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionError title: "expressionError" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionError plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionError'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_gauge.mdx b/api_docs/expression_gauge.mdx index 188dfefa8eae9..e50484b266e4c 100644 --- a/api_docs/expression_gauge.mdx +++ b/api_docs/expression_gauge.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionGauge title: "expressionGauge" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionGauge plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionGauge'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_heatmap.mdx b/api_docs/expression_heatmap.mdx index 0c44764482c58..685f99a7ba9e0 100644 --- a/api_docs/expression_heatmap.mdx +++ b/api_docs/expression_heatmap.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionHeatmap title: "expressionHeatmap" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionHeatmap plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_image.mdx b/api_docs/expression_image.mdx index 7bd3a7bd91d97..2e1f71c8bdd5c 100644 --- a/api_docs/expression_image.mdx +++ b/api_docs/expression_image.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionImage title: "expressionImage" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionImage plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionImage'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_legacy_metric_vis.mdx b/api_docs/expression_legacy_metric_vis.mdx index f18026f5b241b..9e6300966a37f 100644 --- a/api_docs/expression_legacy_metric_vis.mdx +++ b/api_docs/expression_legacy_metric_vis.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionLegacyMetricVis title: "expressionLegacyMetricVis" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionLegacyMetricVis plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionLegacyMetricVis'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_metric.mdx b/api_docs/expression_metric.mdx index 53974676b8de4..e8985aa1d6ed7 100644 --- a/api_docs/expression_metric.mdx +++ b/api_docs/expression_metric.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionMetric title: "expressionMetric" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionMetric plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetric'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_metric_vis.mdx b/api_docs/expression_metric_vis.mdx index a5d37b7b29144..ed1d2c1b8385d 100644 --- a/api_docs/expression_metric_vis.mdx +++ b/api_docs/expression_metric_vis.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionMetricVis title: "expressionMetricVis" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionMetricVis plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetricVis'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_partition_vis.mdx b/api_docs/expression_partition_vis.mdx index 113733c074c1b..0dc3ea7c83883 100644 --- a/api_docs/expression_partition_vis.mdx +++ b/api_docs/expression_partition_vis.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionPartitionVis title: "expressionPartitionVis" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionPartitionVis plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionPartitionVis'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_repeat_image.mdx b/api_docs/expression_repeat_image.mdx index b65524ffc23a4..fff23cee1715b 100644 --- a/api_docs/expression_repeat_image.mdx +++ b/api_docs/expression_repeat_image.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionRepeatImage title: "expressionRepeatImage" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionRepeatImage plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRepeatImage'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_reveal_image.mdx b/api_docs/expression_reveal_image.mdx index eaf758ec5ed88..03329e37a283c 100644 --- a/api_docs/expression_reveal_image.mdx +++ b/api_docs/expression_reveal_image.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionRevealImage title: "expressionRevealImage" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionRevealImage plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRevealImage'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_shape.mdx b/api_docs/expression_shape.mdx index 05aa0bb459fd0..e9b3fd2668ae8 100644 --- a/api_docs/expression_shape.mdx +++ b/api_docs/expression_shape.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionShape title: "expressionShape" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionShape plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionShape'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_tagcloud.mdx b/api_docs/expression_tagcloud.mdx index 93b7f382179d8..1cf371bedce39 100644 --- a/api_docs/expression_tagcloud.mdx +++ b/api_docs/expression_tagcloud.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionTagcloud title: "expressionTagcloud" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionTagcloud plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionTagcloud'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_x_y.devdocs.json b/api_docs/expression_x_y.devdocs.json index befebac94be4d..8e4323a0f0114 100644 --- a/api_docs/expression_x_y.devdocs.json +++ b/api_docs/expression_x_y.devdocs.json @@ -595,13 +595,13 @@ }, { "parentPluginId": "expressionXY", - "id": "def-common.DataLayerArgs.splitAccessor", - "type": "CompoundType", + "id": "def-common.DataLayerArgs.splitAccessors", + "type": "Array", "tags": [], - "label": "splitAccessor", + "label": "splitAccessors", "description": [], "signature": [ - "string | ", + "(string | ", { "pluginId": "visualizations", "scope": "common", @@ -609,7 +609,7 @@ "section": "def-common.ExpressionValueVisDimension", "text": "ExpressionValueVisDimension" }, - " | undefined" + ")[] | undefined" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false diff --git a/api_docs/expression_x_y.mdx b/api_docs/expression_x_y.mdx index c8e43d7bc6703..07590478a7e0e 100644 --- a/api_docs/expression_x_y.mdx +++ b/api_docs/expression_x_y.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionXY title: "expressionXY" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionXY plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expressions.devdocs.json b/api_docs/expressions.devdocs.json index f7888f42d35ed..bea645fca66b1 100644 --- a/api_docs/expressions.devdocs.json +++ b/api_docs/expressions.devdocs.json @@ -6710,13 +6710,7 @@ ], "signature": [ "(() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") | undefined" ], "path": "src/plugins/expressions/common/execution/types.ts", @@ -17170,13 +17164,7 @@ ], "signature": [ "(() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") | undefined" ], "path": "src/plugins/expressions/common/execution/types.ts", @@ -28261,13 +28249,7 @@ ], "signature": [ "(() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") | undefined" ], "path": "src/plugins/expressions/common/execution/types.ts", @@ -29807,13 +29789,7 @@ "\nMakes a `KibanaRequest` object available to expression functions. Useful for\nfunctions which are running on the server and need to perform operations that\nare scoped to a specific user." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", " | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", diff --git a/api_docs/expressions.mdx b/api_docs/expressions.mdx index 55a2a78829ee7..f8c304a1aeab4 100644 --- a/api_docs/expressions.mdx +++ b/api_docs/expressions.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressions title: "expressions" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressions plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/features.mdx b/api_docs/features.mdx index 28544e78a1979..d6353777ae421 100644 --- a/api_docs/features.mdx +++ b/api_docs/features.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/features title: "features" image: https://source.unsplash.com/400x175/?github summary: API docs for the features plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/field_formats.mdx b/api_docs/field_formats.mdx index 9e90ef5436b1e..3f308b1e45891 100644 --- a/api_docs/field_formats.mdx +++ b/api_docs/field_formats.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/fieldFormats title: "fieldFormats" image: https://source.unsplash.com/400x175/?github summary: API docs for the fieldFormats plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/file_upload.mdx b/api_docs/file_upload.mdx index dd775f6d2be86..0a0984a7c1b61 100644 --- a/api_docs/file_upload.mdx +++ b/api_docs/file_upload.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/fileUpload title: "fileUpload" image: https://source.unsplash.com/400x175/?github summary: API docs for the fileUpload plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/fleet.devdocs.json b/api_docs/fleet.devdocs.json index 88c1b5ee80528..0e8db05a8eb7a 100644 --- a/api_docs/fleet.devdocs.json +++ b/api_docs/fleet.devdocs.json @@ -5056,13 +5056,7 @@ ], "signature": [ "(req: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", { "pluginId": "fleet", @@ -5083,13 +5077,7 @@ "label": "req", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/fleet/server/services/agents/agent_service.ts", @@ -7484,13 +7472,7 @@ "text": "RequestHandlerContext" }, ", request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => Promise" ], "path": "x-pack/plugins/fleet/server/services/package_policy.ts", @@ -7747,13 +7723,7 @@ "description": [], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", { "pluginId": "fleet", @@ -7774,13 +7744,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/fleet/server/services/epm/package_service.ts", @@ -7890,13 +7854,7 @@ "text": "RequestHandlerContext" }, ", request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => Promise<", { "pluginId": "fleet", @@ -7957,13 +7915,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/fleet/server/types/extensions.ts", @@ -8046,13 +7998,7 @@ "text": "RequestHandlerContext" }, ", request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => Promise<", { "pluginId": "fleet", @@ -8113,13 +8059,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/fleet/server/types/extensions.ts", @@ -8153,13 +8093,7 @@ "text": "RequestHandlerContext" }, ", request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => Promise<", { "pluginId": "fleet", @@ -8220,13 +8154,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/fleet/server/types/extensions.ts", @@ -8290,13 +8218,7 @@ "description": [], "signature": [ "{ fromRequest(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "): Promise<", { "pluginId": "fleet", @@ -12273,7 +12195,7 @@ "label": "developer", "description": [], "signature": [ - "{ disableRegistryVersionCheck?: boolean | undefined; allowAgentUpgradeSourceUri?: boolean | undefined; bundledPackageLocation?: string | undefined; } | undefined" + "{ disableRegistryVersionCheck?: boolean | undefined; bundledPackageLocation?: string | undefined; } | undefined" ], "path": "x-pack/plugins/fleet/common/types/index.ts", "deprecated": false @@ -13341,7 +13263,7 @@ "label": "agent", "description": [], "signature": [ - "{ monitoring: { namespace?: string | undefined; use_output?: string | undefined; enabled: boolean; metrics: boolean; logs: boolean; }; } | undefined" + "{ monitoring: { namespace?: string | undefined; use_output?: string | undefined; enabled: boolean; metrics: boolean; logs: boolean; }; download: { source_uri: string; }; } | undefined" ], "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false @@ -15873,13 +15795,7 @@ "text": "ListWithKuery" }, " extends ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpFetchQuery", - "text": "HttpFetchQuery" - } + "HttpFetchQuery" ], "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", "deprecated": false, @@ -16114,6 +16030,19 @@ ], "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.NewAgentAction.source_uri", + "type": "string", + "tags": [], + "label": "source_uri", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false } ], "initialIsOpen": false @@ -20681,7 +20610,7 @@ "label": "DEFAULT_DOWNLOAD_SOURCE", "description": [], "signature": [ - "\"artifactory.elastic.co\"" + "\"https://artifacts.elastic.co\"" ], "path": "x-pack/plugins/fleet/common/constants/download_source.ts", "deprecated": false, @@ -22467,7 +22396,7 @@ "label": "PackageSpecCategory", "description": [], "signature": [ - "\"custom\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\"" + "\"custom\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"threat_intel\" | \"ticketing\" | \"version_control\" | \"web\"" ], "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "deprecated": false, diff --git a/api_docs/fleet.mdx b/api_docs/fleet.mdx index 8c2a1163e62bc..9e4d8abbf4299 100644 --- a/api_docs/fleet.mdx +++ b/api_docs/fleet.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/fleet title: "fleet" image: https://source.unsplash.com/400x175/?github summary: API docs for the fleet plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Fleet](https://github.com/orgs/elastic/teams/fleet) for questions regar | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 1521 | 8 | 1389 | 10 | +| 1522 | 8 | 1390 | 10 | ## Client diff --git a/api_docs/global_search.devdocs.json b/api_docs/global_search.devdocs.json index 1dcfc8ae83bac..4c1ca7278bff6 100644 --- a/api_docs/global_search.devdocs.json +++ b/api_docs/global_search.devdocs.json @@ -1123,25 +1123,13 @@ "text": "GlobalSearchFindOptions" }, ", request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", "Observable", "<", "GlobalSearchBatchedResults", ">; getSearchableTypes: (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => Promise; }" ], "path": "x-pack/plugins/global_search/server/types.ts", diff --git a/api_docs/global_search.mdx b/api_docs/global_search.mdx index 8474a5e08cc62..dd60d001c83c5 100644 --- a/api_docs/global_search.mdx +++ b/api_docs/global_search.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/globalSearch title: "globalSearch" image: https://source.unsplash.com/400x175/?github summary: API docs for the globalSearch plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/home.mdx b/api_docs/home.mdx index 17c3c86417954..dcf20af6a1d11 100644 --- a/api_docs/home.mdx +++ b/api_docs/home.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/home title: "home" image: https://source.unsplash.com/400x175/?github summary: API docs for the home plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'home'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/index_lifecycle_management.mdx b/api_docs/index_lifecycle_management.mdx index 2976130f0426b..c806e66c7e64b 100644 --- a/api_docs/index_lifecycle_management.mdx +++ b/api_docs/index_lifecycle_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/indexLifecycleManagement title: "indexLifecycleManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the indexLifecycleManagement plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexLifecycleManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/index_management.mdx b/api_docs/index_management.mdx index 37c9150cedd5f..05e767cf2fc4c 100644 --- a/api_docs/index_management.mdx +++ b/api_docs/index_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/indexManagement title: "indexManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the indexManagement plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/infra.mdx b/api_docs/infra.mdx index ce250ea235796..d2c9347b374b5 100644 --- a/api_docs/infra.mdx +++ b/api_docs/infra.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/infra title: "infra" image: https://source.unsplash.com/400x175/?github summary: API docs for the infra plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/inspector.mdx b/api_docs/inspector.mdx index b77ff9a441821..db6eb55ddad01 100644 --- a/api_docs/inspector.mdx +++ b/api_docs/inspector.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/inspector title: "inspector" image: https://source.unsplash.com/400x175/?github summary: API docs for the inspector plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inspector'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/interactive_setup.mdx b/api_docs/interactive_setup.mdx index a52c185646472..632870059bc83 100644 --- a/api_docs/interactive_setup.mdx +++ b/api_docs/interactive_setup.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/interactiveSetup title: "interactiveSetup" image: https://source.unsplash.com/400x175/?github summary: API docs for the interactiveSetup plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'interactiveSetup'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_ace.mdx b/api_docs/kbn_ace.mdx index a03bc524f6146..d33da0ffedfeb 100644 --- a/api_docs/kbn_ace.mdx +++ b/api_docs/kbn_ace.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ace title: "@kbn/ace" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ace plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ace'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_aiops_components.mdx b/api_docs/kbn_aiops_components.mdx index 12f157c31ce52..67908b73aaf91 100644 --- a/api_docs/kbn_aiops_components.mdx +++ b/api_docs/kbn_aiops_components.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-components title: "@kbn/aiops-components" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/aiops-components plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-components'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_aiops_utils.mdx b/api_docs/kbn_aiops_utils.mdx index 748f8d759cfa2..16b93b3725319 100644 --- a/api_docs/kbn_aiops_utils.mdx +++ b/api_docs/kbn_aiops_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-utils title: "@kbn/aiops-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/aiops-utils plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_alerts.mdx b/api_docs/kbn_alerts.mdx index e88429db95337..50b568cc1982a 100644 --- a/api_docs/kbn_alerts.mdx +++ b/api_docs/kbn_alerts.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-alerts title: "@kbn/alerts" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/alerts plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_analytics.mdx b/api_docs/kbn_analytics.mdx index ed7e0280c2073..13aa2734bd079 100644 --- a/api_docs/kbn_analytics.mdx +++ b/api_docs/kbn_analytics.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics title: "@kbn/analytics" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/analytics plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_analytics_client.mdx b/api_docs/kbn_analytics_client.mdx index 5c38d08fcca7b..276c72a842dfc 100644 --- a/api_docs/kbn_analytics_client.mdx +++ b/api_docs/kbn_analytics_client.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-client title: "@kbn/analytics-client" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/analytics-client plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-client'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx index f6875f4260270..4b9a8759b2b1b 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx +++ b/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-browser title: "@kbn/analytics-shippers-elastic-v3-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/analytics-shippers-elastic-v3-browser plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-browser'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx index e9bd560607daf..7e0390fc7d255 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx +++ b/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-common title: "@kbn/analytics-shippers-elastic-v3-common" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/analytics-shippers-elastic-v3-common plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-common'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx index 21fd9288b116d..8e9c1a191211b 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx +++ b/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-server title: "@kbn/analytics-shippers-elastic-v3-server" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/analytics-shippers-elastic-v3-server plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-server'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_analytics_shippers_fullstory.mdx b/api_docs/kbn_analytics_shippers_fullstory.mdx index 5b6c4f255efa9..17813d56492b2 100644 --- a/api_docs/kbn_analytics_shippers_fullstory.mdx +++ b/api_docs/kbn_analytics_shippers_fullstory.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-fullstory title: "@kbn/analytics-shippers-fullstory" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/analytics-shippers-fullstory plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-fullstory'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_apm_config_loader.mdx b/api_docs/kbn_apm_config_loader.mdx index 015df16445fe5..5c00309bd8842 100644 --- a/api_docs/kbn_apm_config_loader.mdx +++ b/api_docs/kbn_apm_config_loader.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-apm-config-loader title: "@kbn/apm-config-loader" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/apm-config-loader plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-config-loader'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_apm_utils.mdx b/api_docs/kbn_apm_utils.mdx index e7aff01878e85..5203af444072a 100644 --- a/api_docs/kbn_apm_utils.mdx +++ b/api_docs/kbn_apm_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-apm-utils title: "@kbn/apm-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/apm-utils plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_axe_config.mdx b/api_docs/kbn_axe_config.mdx index e258a30230fb7..c94abfadcbe05 100644 --- a/api_docs/kbn_axe_config.mdx +++ b/api_docs/kbn_axe_config.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-axe-config title: "@kbn/axe-config" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/axe-config plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/axe-config'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_bazel_packages.devdocs.json b/api_docs/kbn_bazel_packages.devdocs.json index 993554aca7636..23cf46d140b55 100644 --- a/api_docs/kbn_bazel_packages.devdocs.json +++ b/api_docs/kbn_bazel_packages.devdocs.json @@ -273,7 +273,7 @@ "\nResolve all the BAZEL_PACKAGE_DIRS to absolute paths" ], "signature": [ - "() => EntryInternal[] & string[]" + "() => string[]" ], "path": "packages/kbn-bazel-packages/src/bazel_package_dirs.ts", "deprecated": false, diff --git a/api_docs/kbn_bazel_packages.mdx b/api_docs/kbn_bazel_packages.mdx index 88fa1bea3ec94..99c31ede3a39d 100644 --- a/api_docs/kbn_bazel_packages.mdx +++ b/api_docs/kbn_bazel_packages.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-bazel-packages title: "@kbn/bazel-packages" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/bazel-packages plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/bazel-packages'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_bazel_runner.mdx b/api_docs/kbn_bazel_runner.mdx index 1f35a1d4bed1d..6d99f6c5f5299 100644 --- a/api_docs/kbn_bazel_runner.mdx +++ b/api_docs/kbn_bazel_runner.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-bazel-runner title: "@kbn/bazel-runner" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/bazel-runner plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/bazel-runner'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_ci_stats_core.mdx b/api_docs/kbn_ci_stats_core.mdx index e3a88a18f7a14..dc14fb459eb97 100644 --- a/api_docs/kbn_ci_stats_core.mdx +++ b/api_docs/kbn_ci_stats_core.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-core title: "@kbn/ci-stats-core" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ci-stats-core plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-core'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_ci_stats_performance_metrics.mdx b/api_docs/kbn_ci_stats_performance_metrics.mdx index 24310abb47739..38dc0a15f5175 100644 --- a/api_docs/kbn_ci_stats_performance_metrics.mdx +++ b/api_docs/kbn_ci_stats_performance_metrics.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-performance-metrics title: "@kbn/ci-stats-performance-metrics" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ci-stats-performance-metrics plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-performance-metrics'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_ci_stats_reporter.mdx b/api_docs/kbn_ci_stats_reporter.mdx index 2f5778175c7c1..869643ad84802 100644 --- a/api_docs/kbn_ci_stats_reporter.mdx +++ b/api_docs/kbn_ci_stats_reporter.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-reporter title: "@kbn/ci-stats-reporter" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ci-stats-reporter plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-reporter'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_cli_dev_mode.mdx b/api_docs/kbn_cli_dev_mode.mdx index 03824e43f3d3b..15587ab667343 100644 --- a/api_docs/kbn_cli_dev_mode.mdx +++ b/api_docs/kbn_cli_dev_mode.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-cli-dev-mode title: "@kbn/cli-dev-mode" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/cli-dev-mode plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cli-dev-mode'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_coloring.mdx b/api_docs/kbn_coloring.mdx index f1e29569f57fe..471a883e4db00 100644 --- a/api_docs/kbn_coloring.mdx +++ b/api_docs/kbn_coloring.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-coloring title: "@kbn/coloring" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/coloring plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/coloring'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_config.mdx b/api_docs/kbn_config.mdx index 86d97a5b56bd8..e3f717c4d980a 100644 --- a/api_docs/kbn_config.mdx +++ b/api_docs/kbn_config.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-config title: "@kbn/config" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/config plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_config_mocks.mdx b/api_docs/kbn_config_mocks.mdx index b7b7652aca4c5..c8d686e8deda8 100644 --- a/api_docs/kbn_config_mocks.mdx +++ b/api_docs/kbn_config_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-config-mocks title: "@kbn/config-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/config-mocks plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_config_schema.mdx b/api_docs/kbn_config_schema.mdx index 6b61cd7115081..a9387c456838b 100644 --- a/api_docs/kbn_config_schema.mdx +++ b/api_docs/kbn_config_schema.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-config-schema title: "@kbn/config-schema" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/config-schema plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config-schema'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_analytics_browser.mdx b/api_docs/kbn_core_analytics_browser.mdx index e2624d60c9802..2fc459ffbbe1a 100644 --- a/api_docs/kbn_core_analytics_browser.mdx +++ b/api_docs/kbn_core_analytics_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-browser title: "@kbn/core-analytics-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-analytics-browser plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-browser'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_analytics_browser_internal.mdx b/api_docs/kbn_core_analytics_browser_internal.mdx index 0cf1695af6a7c..c28cc9230262a 100644 --- a/api_docs/kbn_core_analytics_browser_internal.mdx +++ b/api_docs/kbn_core_analytics_browser_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-browser-internal title: "@kbn/core-analytics-browser-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-analytics-browser-internal plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-browser-internal'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_analytics_browser_mocks.mdx b/api_docs/kbn_core_analytics_browser_mocks.mdx index b7ee3a9f6ae52..c3dea4bb4fec1 100644 --- a/api_docs/kbn_core_analytics_browser_mocks.mdx +++ b/api_docs/kbn_core_analytics_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-browser-mocks title: "@kbn/core-analytics-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-analytics-browser-mocks plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-browser-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_analytics_server.mdx b/api_docs/kbn_core_analytics_server.mdx index 4a1e2d0280c48..f2f99d527dd31 100644 --- a/api_docs/kbn_core_analytics_server.mdx +++ b/api_docs/kbn_core_analytics_server.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-server title: "@kbn/core-analytics-server" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-analytics-server plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-server'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_analytics_server_internal.mdx b/api_docs/kbn_core_analytics_server_internal.mdx index 51ff788a42df0..e6e247e4970ab 100644 --- a/api_docs/kbn_core_analytics_server_internal.mdx +++ b/api_docs/kbn_core_analytics_server_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-server-internal title: "@kbn/core-analytics-server-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-analytics-server-internal plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-server-internal'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_analytics_server_mocks.mdx b/api_docs/kbn_core_analytics_server_mocks.mdx index 5d593fdd7ecc3..92e3d24c1bedb 100644 --- a/api_docs/kbn_core_analytics_server_mocks.mdx +++ b/api_docs/kbn_core_analytics_server_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-server-mocks title: "@kbn/core-analytics-server-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-analytics-server-mocks plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-server-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_base_browser_mocks.mdx b/api_docs/kbn_core_base_browser_mocks.mdx index edd00ea495a03..ad6288df80ee0 100644 --- a/api_docs/kbn_core_base_browser_mocks.mdx +++ b/api_docs/kbn_core_base_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-browser-mocks title: "@kbn/core-base-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-base-browser-mocks plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-browser-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_base_common.mdx b/api_docs/kbn_core_base_common.mdx index 010ee8d9c3efb..ba1e4abd15ae2 100644 --- a/api_docs/kbn_core_base_common.mdx +++ b/api_docs/kbn_core_base_common.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-common title: "@kbn/core-base-common" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-base-common plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-common'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_base_server_internal.mdx b/api_docs/kbn_core_base_server_internal.mdx index b9660c993e9d5..c7d4e0c80c19e 100644 --- a/api_docs/kbn_core_base_server_internal.mdx +++ b/api_docs/kbn_core_base_server_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-server-internal title: "@kbn/core-base-server-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-base-server-internal plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-server-internal'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_base_server_mocks.mdx b/api_docs/kbn_core_base_server_mocks.mdx index 601a93cf0ac3d..d2b99c2f95faf 100644 --- a/api_docs/kbn_core_base_server_mocks.mdx +++ b/api_docs/kbn_core_base_server_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-server-mocks title: "@kbn/core-base-server-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-base-server-mocks plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-server-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_config_server_internal.mdx b/api_docs/kbn_core_config_server_internal.mdx index 5690498d83f5b..9c7741208effb 100644 --- a/api_docs/kbn_core_config_server_internal.mdx +++ b/api_docs/kbn_core_config_server_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-config-server-internal title: "@kbn/core-config-server-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-config-server-internal plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-config-server-internal'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_doc_links_browser.mdx b/api_docs/kbn_core_doc_links_browser.mdx index 8b6855dd35b36..1a969e948111d 100644 --- a/api_docs/kbn_core_doc_links_browser.mdx +++ b/api_docs/kbn_core_doc_links_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-browser title: "@kbn/core-doc-links-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-doc-links-browser plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-browser'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_doc_links_browser_mocks.mdx b/api_docs/kbn_core_doc_links_browser_mocks.mdx index 7a7b6e70f7dff..cd9441faafeae 100644 --- a/api_docs/kbn_core_doc_links_browser_mocks.mdx +++ b/api_docs/kbn_core_doc_links_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-browser-mocks title: "@kbn/core-doc-links-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-doc-links-browser-mocks plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-browser-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_doc_links_server.mdx b/api_docs/kbn_core_doc_links_server.mdx index 188729bcb5d5a..e960e0a78e180 100644 --- a/api_docs/kbn_core_doc_links_server.mdx +++ b/api_docs/kbn_core_doc_links_server.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-server title: "@kbn/core-doc-links-server" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-doc-links-server plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-server'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_doc_links_server_mocks.mdx b/api_docs/kbn_core_doc_links_server_mocks.mdx index ef26b60250ac2..6fcdb8e176c21 100644 --- a/api_docs/kbn_core_doc_links_server_mocks.mdx +++ b/api_docs/kbn_core_doc_links_server_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-server-mocks title: "@kbn/core-doc-links-server-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-doc-links-server-mocks plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-server-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_environment_server_internal.mdx b/api_docs/kbn_core_environment_server_internal.mdx index d18c98c419302..51a204698e524 100644 --- a/api_docs/kbn_core_environment_server_internal.mdx +++ b/api_docs/kbn_core_environment_server_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-environment-server-internal title: "@kbn/core-environment-server-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-environment-server-internal plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-environment-server-internal'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_environment_server_mocks.mdx b/api_docs/kbn_core_environment_server_mocks.mdx index 2dbc0c75fb5d3..d430edc47a08a 100644 --- a/api_docs/kbn_core_environment_server_mocks.mdx +++ b/api_docs/kbn_core_environment_server_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-environment-server-mocks title: "@kbn/core-environment-server-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-environment-server-mocks plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-environment-server-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_execution_context_browser.mdx b/api_docs/kbn_core_execution_context_browser.mdx index c87c7e6bc8aa0..83698a759bb1b 100644 --- a/api_docs/kbn_core_execution_context_browser.mdx +++ b/api_docs/kbn_core_execution_context_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-browser title: "@kbn/core-execution-context-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-execution-context-browser plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-browser'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_execution_context_browser_internal.mdx b/api_docs/kbn_core_execution_context_browser_internal.mdx index fe5a4e38723e8..ea919a39c9a6d 100644 --- a/api_docs/kbn_core_execution_context_browser_internal.mdx +++ b/api_docs/kbn_core_execution_context_browser_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-browser-internal title: "@kbn/core-execution-context-browser-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-execution-context-browser-internal plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-browser-internal'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_execution_context_browser_mocks.mdx b/api_docs/kbn_core_execution_context_browser_mocks.mdx index 03064c9aa9736..05abf8327f857 100644 --- a/api_docs/kbn_core_execution_context_browser_mocks.mdx +++ b/api_docs/kbn_core_execution_context_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-browser-mocks title: "@kbn/core-execution-context-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-execution-context-browser-mocks plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-browser-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_execution_context_common.mdx b/api_docs/kbn_core_execution_context_common.mdx index 5d9ea672a742f..959a2dbc027ba 100644 --- a/api_docs/kbn_core_execution_context_common.mdx +++ b/api_docs/kbn_core_execution_context_common.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-common title: "@kbn/core-execution-context-common" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-execution-context-common plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-common'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_execution_context_server.mdx b/api_docs/kbn_core_execution_context_server.mdx index 5cde6bdcc71df..a88ed431d022f 100644 --- a/api_docs/kbn_core_execution_context_server.mdx +++ b/api_docs/kbn_core_execution_context_server.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-server title: "@kbn/core-execution-context-server" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-execution-context-server plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-server'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_execution_context_server_internal.mdx b/api_docs/kbn_core_execution_context_server_internal.mdx index 91a783c509259..22d3cdf2819ec 100644 --- a/api_docs/kbn_core_execution_context_server_internal.mdx +++ b/api_docs/kbn_core_execution_context_server_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-server-internal title: "@kbn/core-execution-context-server-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-execution-context-server-internal plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-server-internal'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_execution_context_server_mocks.mdx b/api_docs/kbn_core_execution_context_server_mocks.mdx index ca81141eab3b8..368b325e127a5 100644 --- a/api_docs/kbn_core_execution_context_server_mocks.mdx +++ b/api_docs/kbn_core_execution_context_server_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-server-mocks title: "@kbn/core-execution-context-server-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-execution-context-server-mocks plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-server-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_fatal_errors_browser.mdx b/api_docs/kbn_core_fatal_errors_browser.mdx index d61d3291f30c7..a7b2329ec2369 100644 --- a/api_docs/kbn_core_fatal_errors_browser.mdx +++ b/api_docs/kbn_core_fatal_errors_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-fatal-errors-browser title: "@kbn/core-fatal-errors-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-fatal-errors-browser plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-fatal-errors-browser'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_fatal_errors_browser_mocks.mdx b/api_docs/kbn_core_fatal_errors_browser_mocks.mdx index fd0fc8701dc42..bfea5fb0095d6 100644 --- a/api_docs/kbn_core_fatal_errors_browser_mocks.mdx +++ b/api_docs/kbn_core_fatal_errors_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-fatal-errors-browser-mocks title: "@kbn/core-fatal-errors-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-fatal-errors-browser-mocks plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-fatal-errors-browser-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_http_browser.devdocs.json b/api_docs/kbn_core_http_browser.devdocs.json new file mode 100644 index 0000000000000..492a459206603 --- /dev/null +++ b/api_docs/kbn_core_http_browser.devdocs.json @@ -0,0 +1,2086 @@ +{ + "id": "@kbn/core-http-browser", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.isHttpFetchError", + "type": "Function", + "tags": [], + "label": "isHttpFetchError", + "description": [], + "signature": [ + "(error: ", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IHttpFetchError", + "text": "IHttpFetchError" + }, + " | T) => boolean" + ], + "path": "packages/core/http/core-http-browser/src/utils.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.isHttpFetchError.$1", + "type": "CompoundType", + "tags": [], + "label": "error", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IHttpFetchError", + "text": "IHttpFetchError" + }, + " | T" + ], + "path": "packages/core/http/core-http-browser/src/utils.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpFetchOptions", + "type": "Interface", + "tags": [], + "label": "HttpFetchOptions", + "description": [ + "\nAll options that may be used with a {@link HttpHandler}." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpFetchOptions", + "text": "HttpFetchOptions" + }, + " extends ", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpRequestInit", + "text": "HttpRequestInit" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpFetchOptions.query", + "type": "Object", + "tags": [], + "label": "query", + "description": [ + "\nThe query string for an HTTP request. See {@link HttpFetchQuery}." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpFetchQuery", + "text": "HttpFetchQuery" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpFetchOptions.prependBasePath", + "type": "CompoundType", + "tags": [], + "label": "prependBasePath", + "description": [ + "\nWhether or not the request should automatically prepend the basePath. Defaults to `true`." + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpFetchOptions.headers", + "type": "Object", + "tags": [], + "label": "headers", + "description": [ + "\nHeaders to send with the request. See {@link HttpHeadersInit}." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpHeadersInit", + "text": "HttpHeadersInit" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpFetchOptions.asSystemRequest", + "type": "CompoundType", + "tags": [], + "label": "asSystemRequest", + "description": [ + "\nWhether or not the request should include the \"system request\" header to differentiate an end user request from\nKibana internal request.\nCan be read on the server-side using KibanaRequest#isSystemRequest. Defaults to `false`." + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpFetchOptions.asResponse", + "type": "CompoundType", + "tags": [], + "label": "asResponse", + "description": [ + "\nWhen `true` the return type of {@link HttpHandler} will be an {@link HttpResponse} with detailed request and\nresponse information. When `false`, the return type will just be the parsed response body. Defaults to `false`." + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpFetchOptions.context", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "KibanaExecutionContext", + " | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpFetchOptionsWithPath", + "type": "Interface", + "tags": [], + "label": "HttpFetchOptionsWithPath", + "description": [ + "\nSimilar to {@link HttpFetchOptions} but with the URL path included." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpFetchOptionsWithPath", + "text": "HttpFetchOptionsWithPath" + }, + " extends ", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpFetchOptions", + "text": "HttpFetchOptions" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpFetchOptionsWithPath.path", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpFetchQuery", + "type": "Interface", + "tags": [], + "label": "HttpFetchQuery", + "description": [], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpFetchQuery.Unnamed", + "type": "IndexSignature", + "tags": [], + "label": "[key: string]: string | number | boolean | string[] | number[] | boolean[] | null | undefined", + "description": [ + "\nTypeScript note: Technically we should use this interface instead, but @types/node uses the below stricter\ndefinition, so to avoid TypeScript errors, we'll restrict our version.\n\n[key: string]:\n | string\n | number\n | boolean\n | Array\n | undefined\n | null;" + ], + "signature": [ + "[key: string]: string | number | boolean | string[] | number[] | boolean[] | null | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpHandler", + "type": "Interface", + "tags": [], + "label": "HttpHandler", + "description": [ + "\nA function for making an HTTP requests to Kibana's backend. See {@link HttpFetchOptions} for options and\n{@link HttpResponse} for the response.\n" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpHandler.Unnamed", + "type": "Any", + "tags": [], + "label": "Unnamed", + "description": [], + "signature": [ + "any" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpHandler.Unnamed", + "type": "Any", + "tags": [], + "label": "Unnamed", + "description": [], + "signature": [ + "any" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpHandler.Unnamed", + "type": "Any", + "tags": [], + "label": "Unnamed", + "description": [], + "signature": [ + "any" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpHandler.Unnamed", + "type": "Any", + "tags": [], + "label": "Unnamed", + "description": [], + "signature": [ + "any" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpHeadersInit", + "type": "Interface", + "tags": [], + "label": "HttpHeadersInit", + "description": [ + "\nHeaders to append to the request. Any headers that begin with `kbn-` are considered private to Core and will cause\n{@link HttpHandler} to throw an error." + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpHeadersInit.Unnamed", + "type": "IndexSignature", + "tags": [], + "label": "[name: string]: any", + "description": [], + "signature": [ + "[name: string]: any" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptor", + "type": "Interface", + "tags": [], + "label": "HttpInterceptor", + "description": [ + "\nAn object that may define global interceptor functions for different parts of the request and response lifecycle.\nSee {@link IHttpInterceptController}.\n" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptor.request", + "type": "Function", + "tags": [], + "label": "request", + "description": [ + "\nDefine an interceptor to be executed before a request is sent." + ], + "signature": [ + "((fetchOptions: Readonly<", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpFetchOptionsWithPath", + "text": "HttpFetchOptionsWithPath" + }, + ">, controller: ", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IHttpInterceptController", + "text": "IHttpInterceptController" + }, + ") => void | ", + "MaybePromise", + ">) | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptor.request.$1", + "type": "Object", + "tags": [], + "label": "fetchOptions", + "description": [], + "signature": [ + "Readonly<", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpFetchOptionsWithPath", + "text": "HttpFetchOptionsWithPath" + }, + ">" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptor.request.$2", + "type": "Object", + "tags": [], + "label": "controller", + "description": [ + "{@link IHttpInterceptController }" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IHttpInterceptController", + "text": "IHttpInterceptController" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptor.requestError", + "type": "Function", + "tags": [], + "label": "requestError", + "description": [ + "\nDefine an interceptor to be executed if a request interceptor throws an error or returns a rejected Promise." + ], + "signature": [ + "((httpErrorRequest: ", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpInterceptorRequestError", + "text": "HttpInterceptorRequestError" + }, + ", controller: ", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IHttpInterceptController", + "text": "IHttpInterceptController" + }, + ") => void | ", + "MaybePromise", + ">) | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptor.requestError.$1", + "type": "Object", + "tags": [], + "label": "httpErrorRequest", + "description": [ + "{@link HttpInterceptorRequestError }" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpInterceptorRequestError", + "text": "HttpInterceptorRequestError" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptor.requestError.$2", + "type": "Object", + "tags": [], + "label": "controller", + "description": [ + "{@link IHttpInterceptController }" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IHttpInterceptController", + "text": "IHttpInterceptController" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptor.response", + "type": "Function", + "tags": [], + "label": "response", + "description": [ + "\nDefine an interceptor to be executed after a response is received." + ], + "signature": [ + "((httpResponse: ", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpResponse", + "text": "HttpResponse" + }, + ", controller: ", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IHttpInterceptController", + "text": "IHttpInterceptController" + }, + ") => void | ", + "MaybePromise", + "<", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IHttpResponseInterceptorOverrides", + "text": "IHttpResponseInterceptorOverrides" + }, + ">) | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptor.response.$1", + "type": "Object", + "tags": [], + "label": "httpResponse", + "description": [ + "{@link HttpResponse }" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpResponse", + "text": "HttpResponse" + }, + "" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptor.response.$2", + "type": "Object", + "tags": [], + "label": "controller", + "description": [ + "{@link IHttpInterceptController }" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IHttpInterceptController", + "text": "IHttpInterceptController" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptor.responseError", + "type": "Function", + "tags": [], + "label": "responseError", + "description": [ + "\nDefine an interceptor to be executed if a response interceptor throws an error or returns a rejected Promise." + ], + "signature": [ + "((httpErrorResponse: ", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpInterceptorResponseError", + "text": "HttpInterceptorResponseError" + }, + ", controller: ", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IHttpInterceptController", + "text": "IHttpInterceptController" + }, + ") => void | ", + "MaybePromise", + "<", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IHttpResponseInterceptorOverrides", + "text": "IHttpResponseInterceptorOverrides" + }, + ">) | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptor.responseError.$1", + "type": "Object", + "tags": [], + "label": "httpErrorResponse", + "description": [ + "{@link HttpInterceptorResponseError }" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpInterceptorResponseError", + "text": "HttpInterceptorResponseError" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptor.responseError.$2", + "type": "Object", + "tags": [], + "label": "controller", + "description": [ + "{@link IHttpInterceptController }" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IHttpInterceptController", + "text": "IHttpInterceptController" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptorRequestError", + "type": "Interface", + "tags": [], + "label": "HttpInterceptorRequestError", + "description": [], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptorRequestError.fetchOptions", + "type": "Object", + "tags": [], + "label": "fetchOptions", + "description": [], + "signature": [ + "{ readonly path: string; readonly query?: ", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpFetchQuery", + "text": "HttpFetchQuery" + }, + " | undefined; readonly prependBasePath?: boolean | undefined; readonly headers?: ", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpHeadersInit", + "text": "HttpHeadersInit" + }, + " | undefined; readonly asSystemRequest?: boolean | undefined; readonly asResponse?: boolean | undefined; readonly context?: ", + "KibanaExecutionContext", + " | undefined; readonly body?: BodyInit | null | undefined; readonly cache?: RequestCache | undefined; readonly credentials?: RequestCredentials | undefined; readonly integrity?: string | undefined; readonly keepalive?: boolean | undefined; readonly method?: string | undefined; readonly mode?: RequestMode | undefined; readonly redirect?: RequestRedirect | undefined; readonly referrer?: string | undefined; readonly referrerPolicy?: ReferrerPolicy | undefined; readonly signal?: AbortSignal | null | undefined; readonly window?: null | undefined; }" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptorRequestError.error", + "type": "Object", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "Error" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptorResponseError", + "type": "Interface", + "tags": [], + "label": "HttpInterceptorResponseError", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpInterceptorResponseError", + "text": "HttpInterceptorResponseError" + }, + " extends ", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpResponse", + "text": "HttpResponse" + }, + "" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptorResponseError.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "{ readonly cache: RequestCache; readonly credentials: RequestCredentials; readonly destination: RequestDestination; readonly headers: Headers; readonly integrity: string; readonly keepalive: boolean; readonly method: string; readonly mode: RequestMode; readonly redirect: RequestRedirect; readonly referrer: string; readonly referrerPolicy: ReferrerPolicy; readonly signal: AbortSignal; readonly url: string; readonly clone: () => Request; readonly body: ReadableStream | null; readonly bodyUsed: boolean; readonly arrayBuffer: () => Promise; readonly blob: () => Promise; readonly formData: () => Promise; readonly json: () => Promise; readonly text: () => Promise; }" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptorResponseError.error", + "type": "CompoundType", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "Error | ", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IHttpFetchError", + "text": "IHttpFetchError" + }, + "" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpRequestInit", + "type": "Interface", + "tags": [], + "label": "HttpRequestInit", + "description": [ + "\nFetch API options available to {@link HttpHandler}s.\n" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpRequestInit.body", + "type": "CompoundType", + "tags": [], + "label": "body", + "description": [ + "\nA BodyInit object or null to set request's body." + ], + "signature": [ + "BodyInit | null | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpRequestInit.cache", + "type": "CompoundType", + "tags": [], + "label": "cache", + "description": [ + "\nThe cache mode associated with request, which is a string indicating how the request will interact with the\nbrowser's cache when fetching." + ], + "signature": [ + "RequestCache | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpRequestInit.credentials", + "type": "CompoundType", + "tags": [], + "label": "credentials", + "description": [ + "\nThe credentials mode associated with request, which is a string indicating whether credentials will be sent with\nthe request always, never, or only when sent to a same-origin URL." + ], + "signature": [ + "RequestCredentials | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpRequestInit.headers", + "type": "Object", + "tags": [], + "label": "headers", + "description": [ + "{@link HttpHeadersInit}" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpHeadersInit", + "text": "HttpHeadersInit" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpRequestInit.integrity", + "type": "string", + "tags": [], + "label": "integrity", + "description": [ + "\nSubresource integrity metadata, which is a cryptographic hash of the resource being fetched. Its value consists of\nmultiple hashes separated by whitespace." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpRequestInit.keepalive", + "type": "CompoundType", + "tags": [], + "label": "keepalive", + "description": [ + "Whether or not request can outlive the global in which it was created." + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpRequestInit.method", + "type": "string", + "tags": [], + "label": "method", + "description": [ + "HTTP method, which is \"GET\" by default." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpRequestInit.mode", + "type": "CompoundType", + "tags": [], + "label": "mode", + "description": [ + "\nThe mode associated with request, which is a string indicating whether the request will use CORS, or will be\nrestricted to same-origin URLs." + ], + "signature": [ + "RequestMode | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpRequestInit.redirect", + "type": "CompoundType", + "tags": [], + "label": "redirect", + "description": [ + "\nThe redirect mode associated with request, which is a string indicating how redirects for the request will be\nhandled during fetching. A request will follow redirects by default." + ], + "signature": [ + "RequestRedirect | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpRequestInit.referrer", + "type": "string", + "tags": [], + "label": "referrer", + "description": [ + "\nThe referrer of request. Its value can be a same-origin URL if explicitly set in init, the empty string to\nindicate no referrer, and \"about:client\" when defaulting to the global's default. This is used during fetching to\ndetermine the value of the `Referer` header of the request being made." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpRequestInit.referrerPolicy", + "type": "CompoundType", + "tags": [], + "label": "referrerPolicy", + "description": [ + "\nThe referrer policy associated with request. This is used during fetching to compute the value of the request's\nreferrer." + ], + "signature": [ + "ReferrerPolicy | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpRequestInit.signal", + "type": "CompoundType", + "tags": [], + "label": "signal", + "description": [ + "\nReturns the signal associated with request, which is an AbortSignal object indicating whether or not request has\nbeen aborted, and its abort event handler." + ], + "signature": [ + "AbortSignal | null | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpRequestInit.window", + "type": "Uncategorized", + "tags": [], + "label": "window", + "description": [ + "\nCan only be null. Used to disassociate request from any Window." + ], + "signature": [ + "null | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpResponse", + "type": "Interface", + "tags": [], + "label": "HttpResponse", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpResponse", + "text": "HttpResponse" + }, + "" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpResponse.fetchOptions", + "type": "Object", + "tags": [], + "label": "fetchOptions", + "description": [ + "The original {@link HttpFetchOptionsWithPath} used to send this request." + ], + "signature": [ + "{ readonly path: string; readonly query?: ", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpFetchQuery", + "text": "HttpFetchQuery" + }, + " | undefined; readonly prependBasePath?: boolean | undefined; readonly headers?: ", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpHeadersInit", + "text": "HttpHeadersInit" + }, + " | undefined; readonly asSystemRequest?: boolean | undefined; readonly asResponse?: boolean | undefined; readonly context?: ", + "KibanaExecutionContext", + " | undefined; readonly body?: BodyInit | null | undefined; readonly cache?: RequestCache | undefined; readonly credentials?: RequestCredentials | undefined; readonly integrity?: string | undefined; readonly keepalive?: boolean | undefined; readonly method?: string | undefined; readonly mode?: RequestMode | undefined; readonly redirect?: RequestRedirect | undefined; readonly referrer?: string | undefined; readonly referrerPolicy?: ReferrerPolicy | undefined; readonly signal?: AbortSignal | null | undefined; readonly window?: null | undefined; }" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpResponse.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [ + "Raw request sent to Kibana server." + ], + "signature": [ + "{ readonly cache: RequestCache; readonly credentials: RequestCredentials; readonly destination: RequestDestination; readonly headers: Headers; readonly integrity: string; readonly keepalive: boolean; readonly method: string; readonly mode: RequestMode; readonly redirect: RequestRedirect; readonly referrer: string; readonly referrerPolicy: ReferrerPolicy; readonly signal: AbortSignal; readonly url: string; readonly clone: () => Request; readonly body: ReadableStream | null; readonly bodyUsed: boolean; readonly arrayBuffer: () => Promise; readonly blob: () => Promise; readonly formData: () => Promise; readonly json: () => Promise; readonly text: () => Promise; }" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpResponse.response", + "type": "Object", + "tags": [], + "label": "response", + "description": [ + "Raw response received, may be undefined if there was an error." + ], + "signature": [ + "Readonly | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpResponse.body", + "type": "Uncategorized", + "tags": [], + "label": "body", + "description": [ + "Parsed body received, may be undefined if there was an error." + ], + "signature": [ + "TResponseBody | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpSetup", + "type": "Interface", + "tags": [], + "label": "HttpSetup", + "description": [], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpSetup.basePath", + "type": "Object", + "tags": [], + "label": "basePath", + "description": [ + "\nAPIs for manipulating the basePath on URL segments.\nSee {@link IBasePath}" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IBasePath", + "text": "IBasePath" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpSetup.anonymousPaths", + "type": "Object", + "tags": [], + "label": "anonymousPaths", + "description": [ + "\nAPIs for denoting certain paths for not requiring authentication" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IAnonymousPaths", + "text": "IAnonymousPaths" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpSetup.externalUrl", + "type": "Object", + "tags": [], + "label": "externalUrl", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IExternalUrl", + "text": "IExternalUrl" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpSetup.intercept", + "type": "Function", + "tags": [], + "label": "intercept", + "description": [ + "\nAdds a new {@link HttpInterceptor} to the global HTTP client." + ], + "signature": [ + "(interceptor: ", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpInterceptor", + "text": "HttpInterceptor" + }, + ") => () => void" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpSetup.intercept.$1", + "type": "Object", + "tags": [], + "label": "interceptor", + "description": [ + "a {@link HttpInterceptor }" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpInterceptor", + "text": "HttpInterceptor" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "a function for removing the attached interceptor." + ] + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpSetup.fetch", + "type": "Function", + "tags": [], + "label": "fetch", + "description": [ + "Makes an HTTP request. Defaults to a GET request unless overridden. See {@link HttpHandler} for options." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpHandler", + "text": "HttpHandler" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpSetup.delete", + "type": "Function", + "tags": [], + "label": "delete", + "description": [ + "Makes an HTTP request with the DELETE method. See {@link HttpHandler} for options." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpHandler", + "text": "HttpHandler" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpSetup.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [ + "Makes an HTTP request with the GET method. See {@link HttpHandler} for options." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpHandler", + "text": "HttpHandler" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpSetup.head", + "type": "Function", + "tags": [], + "label": "head", + "description": [ + "Makes an HTTP request with the HEAD method. See {@link HttpHandler} for options." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpHandler", + "text": "HttpHandler" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpSetup.options", + "type": "Function", + "tags": [], + "label": "options", + "description": [ + "Makes an HTTP request with the OPTIONS method. See {@link HttpHandler} for options." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpHandler", + "text": "HttpHandler" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpSetup.patch", + "type": "Function", + "tags": [], + "label": "patch", + "description": [ + "Makes an HTTP request with the PATCH method. See {@link HttpHandler} for options." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpHandler", + "text": "HttpHandler" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpSetup.post", + "type": "Function", + "tags": [], + "label": "post", + "description": [ + "Makes an HTTP request with the POST method. See {@link HttpHandler} for options." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpHandler", + "text": "HttpHandler" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpSetup.put", + "type": "Function", + "tags": [], + "label": "put", + "description": [ + "Makes an HTTP request with the PUT method. See {@link HttpHandler} for options." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpHandler", + "text": "HttpHandler" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpSetup.addLoadingCountSource", + "type": "Function", + "tags": [], + "label": "addLoadingCountSource", + "description": [ + "\nAdds a new source of loading counts. Used to show the global loading indicator when sum of all observed counts are\nmore than 0." + ], + "signature": [ + "(countSource$: ", + "Observable", + ") => void" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpSetup.addLoadingCountSource.$1", + "type": "Object", + "tags": [], + "label": "countSource$", + "description": [ + "an Observable to subscribe to for loading count updates." + ], + "signature": [ + "Observable", + "" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpSetup.getLoadingCount$", + "type": "Function", + "tags": [], + "label": "getLoadingCount$", + "description": [ + "\nGet the sum of all loading count sources as a single Observable." + ], + "signature": [ + "() => ", + "Observable", + "" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IAnonymousPaths", + "type": "Interface", + "tags": [], + "label": "IAnonymousPaths", + "description": [ + "\nAPIs for denoting paths as not requiring authentication" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IAnonymousPaths.isAnonymous", + "type": "Function", + "tags": [], + "label": "isAnonymous", + "description": [ + "\nDetermines whether the provided path doesn't require authentication. `path` should include the current basePath." + ], + "signature": [ + "(path: string) => boolean" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IAnonymousPaths.isAnonymous.$1", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IAnonymousPaths.register", + "type": "Function", + "tags": [], + "label": "register", + "description": [ + "\nRegister `path` as not requiring authentication. `path` should not include the current basePath." + ], + "signature": [ + "(path: string) => void" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IAnonymousPaths.register.$1", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IBasePath", + "type": "Interface", + "tags": [], + "label": "IBasePath", + "description": [ + "\nAPIs for manipulating the basePath on URL segments." + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IBasePath.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [ + "\nGets the `basePath` string." + ], + "signature": [ + "() => string" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IBasePath.prepend", + "type": "Function", + "tags": [], + "label": "prepend", + "description": [ + "\nPrepends `path` with the basePath." + ], + "signature": [ + "(url: string) => string" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IBasePath.prepend.$1", + "type": "string", + "tags": [], + "label": "url", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IBasePath.remove", + "type": "Function", + "tags": [], + "label": "remove", + "description": [ + "\nRemoves the prepended basePath from the `path`." + ], + "signature": [ + "(url: string) => string" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IBasePath.remove.$1", + "type": "string", + "tags": [], + "label": "url", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IBasePath.serverBasePath", + "type": "string", + "tags": [], + "label": "serverBasePath", + "description": [ + "\nReturns the server's root basePath as configured, without any namespace prefix.\n\nSee {@link BasePath.get} for getting the basePath value for a specific request" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IBasePath.publicBaseUrl", + "type": "string", + "tags": [], + "label": "publicBaseUrl", + "description": [ + "\nThe server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the\n{@link IBasePath.serverBasePath}.\n" + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IExternalUrl", + "type": "Interface", + "tags": [], + "label": "IExternalUrl", + "description": [ + "\nAPIs for working with external URLs.\n" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IExternalUrl.isInternalUrl", + "type": "Function", + "tags": [], + "label": "isInternalUrl", + "description": [ + "\nDetermines if the provided URL is an internal url.\n" + ], + "signature": [ + "(relativeOrAbsoluteUrl: string) => boolean" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IExternalUrl.isInternalUrl.$1", + "type": "string", + "tags": [], + "label": "relativeOrAbsoluteUrl", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IExternalUrl.validateUrl", + "type": "Function", + "tags": [], + "label": "validateUrl", + "description": [ + "\nDetermines if the provided URL is a valid location to send users.\nValidation is based on the configured allow list in kibana.yml.\n\nIf the URL is valid, then a URL will be returned.\nOtherwise, this will return null.\n" + ], + "signature": [ + "(relativeOrAbsoluteUrl: string) => URL | null" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IExternalUrl.validateUrl.$1", + "type": "string", + "tags": [], + "label": "relativeOrAbsoluteUrl", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IHttpFetchError", + "type": "Interface", + "tags": [], + "label": "IHttpFetchError", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IHttpFetchError", + "text": "IHttpFetchError" + }, + " extends Error" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IHttpFetchError.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IHttpFetchError.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "Request" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IHttpFetchError.response", + "type": "Object", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "Response | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IHttpFetchError.req", + "type": "Object", + "tags": [ + "deprecated" + ], + "label": "req", + "description": [], + "signature": [ + "Request" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": true, + "removeBy": "8.8.0\n\nNote to maintainers: when looking at usages, mind that typical use could be inside a `catch` block,\nso TS and code-reference navigation might not highlight them.", + "references": [] + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IHttpFetchError.res", + "type": "Object", + "tags": [ + "deprecated" + ], + "label": "res", + "description": [], + "signature": [ + "Response | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": true, + "removeBy": "8.8.0\n\nNote to maintainers: when looking at usages, mind that typical use could be inside a `catch` block,\nso TS and code-reference navigation might not highlight them.", + "references": [] + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IHttpFetchError.body", + "type": "Uncategorized", + "tags": [], + "label": "body", + "description": [], + "signature": [ + "TResponseBody | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IHttpInterceptController", + "type": "Interface", + "tags": [], + "label": "IHttpInterceptController", + "description": [ + "\nUsed to halt a request Promise chain in a {@link HttpInterceptor}." + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IHttpInterceptController.halted", + "type": "boolean", + "tags": [], + "label": "halted", + "description": [ + "Whether or not this chain has been halted." + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IHttpInterceptController.halt", + "type": "Function", + "tags": [], + "label": "halt", + "description": [ + "Halt the request Promise chain and do not process further interceptors or response handlers." + ], + "signature": [ + "() => void" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IHttpResponseInterceptorOverrides", + "type": "Interface", + "tags": [], + "label": "IHttpResponseInterceptorOverrides", + "description": [ + "\nProperties that can be returned by HttpInterceptor.request to override the response." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IHttpResponseInterceptorOverrides", + "text": "IHttpResponseInterceptorOverrides" + }, + "" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IHttpResponseInterceptorOverrides.response", + "type": "Object", + "tags": [], + "label": "response", + "description": [ + "Raw response received, may be undefined if there was an error." + ], + "signature": [ + "Readonly | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IHttpResponseInterceptorOverrides.body", + "type": "Uncategorized", + "tags": [], + "label": "body", + "description": [ + "Parsed body received, may be undefined if there was an error." + ], + "signature": [ + "TResponseBody | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.ResponseErrorBody", + "type": "Interface", + "tags": [], + "label": "ResponseErrorBody", + "description": [], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.ResponseErrorBody.message", + "type": "string", + "tags": [], + "label": "message", + "description": [], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.ResponseErrorBody.statusCode", + "type": "number", + "tags": [], + "label": "statusCode", + "description": [], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.ResponseErrorBody.attributes", + "type": "Object", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "Record | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpStart", + "type": "Type", + "tags": [], + "label": "HttpStart", + "description": [ + "\nSee {@link HttpSetup}" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpSetup", + "text": "HttpSetup" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_http_browser.mdx b/api_docs/kbn_core_http_browser.mdx new file mode 100644 index 0000000000000..742d0816a7548 --- /dev/null +++ b/api_docs/kbn_core_http_browser.mdx @@ -0,0 +1,33 @@ +--- +id: kibKbnCoreHttpBrowserPluginApi +slug: /kibana-dev-docs/api/kbn-core-http-browser +title: "@kbn/core-http-browser" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-http-browser plugin +date: 2022-07-13 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-browser'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnCoreHttpBrowserObj from './kbn_core_http_browser.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 111 | 4 | 37 | 0 | + +## Common + +### Functions + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/kbn_core_http_browser_internal.devdocs.json b/api_docs/kbn_core_http_browser_internal.devdocs.json new file mode 100644 index 0000000000000..cfd20889ca70d --- /dev/null +++ b/api_docs/kbn_core_http_browser_internal.devdocs.json @@ -0,0 +1,185 @@ +{ + "id": "@kbn/core-http-browser-internal", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [ + { + "parentPluginId": "@kbn/core-http-browser-internal", + "id": "def-common.BasePath", + "type": "Class", + "tags": [], + "label": "BasePath", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-browser-internal", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserInternalPluginApi", + "section": "def-common.BasePath", + "text": "BasePath" + }, + " implements ", + "IBasePath" + ], + "path": "packages/core/http/core-http-browser-internal/src/base_path.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser-internal", + "id": "def-common.BasePath.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "packages/core/http/core-http-browser-internal/src/base_path.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser-internal", + "id": "def-common.BasePath.Unnamed.$1", + "type": "string", + "tags": [], + "label": "basePath", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/http/core-http-browser-internal/src/base_path.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-browser-internal", + "id": "def-common.BasePath.Unnamed.$2", + "type": "string", + "tags": [], + "label": "serverBasePath", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/http/core-http-browser-internal/src/base_path.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-browser-internal", + "id": "def-common.BasePath.Unnamed.$3", + "type": "string", + "tags": [], + "label": "publicBaseUrl", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/core/http/core-http-browser-internal/src/base_path.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-browser-internal", + "id": "def-common.BasePath.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [], + "signature": [ + "() => string" + ], + "path": "packages/core/http/core-http-browser-internal/src/base_path.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-browser-internal", + "id": "def-common.BasePath.prepend", + "type": "Function", + "tags": [], + "label": "prepend", + "description": [], + "signature": [ + "(path: string) => string" + ], + "path": "packages/core/http/core-http-browser-internal/src/base_path.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser-internal", + "id": "def-common.BasePath.prepend.$1", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/http/core-http-browser-internal/src/base_path.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-browser-internal", + "id": "def-common.BasePath.remove", + "type": "Function", + "tags": [], + "label": "remove", + "description": [], + "signature": [ + "(path: string) => string" + ], + "path": "packages/core/http/core-http-browser-internal/src/base_path.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser-internal", + "id": "def-common.BasePath.remove.$1", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/http/core-http-browser-internal/src/base_path.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_http_browser_internal.mdx b/api_docs/kbn_core_http_browser_internal.mdx new file mode 100644 index 0000000000000..c6859f2ef93e6 --- /dev/null +++ b/api_docs/kbn_core_http_browser_internal.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnCoreHttpBrowserInternalPluginApi +slug: /kibana-dev-docs/api/kbn-core-http-browser-internal +title: "@kbn/core-http-browser-internal" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-http-browser-internal plugin +date: 2022-07-13 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-browser-internal'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnCoreHttpBrowserInternalObj from './kbn_core_http_browser_internal.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 10 | 0 | 10 | 0 | + +## Common + +### Classes + + diff --git a/api_docs/kbn_core_http_browser_mocks.devdocs.json b/api_docs/kbn_core_http_browser_mocks.devdocs.json new file mode 100644 index 0000000000000..6b3ea0bc06e22 --- /dev/null +++ b/api_docs/kbn_core_http_browser_mocks.devdocs.json @@ -0,0 +1,316 @@ +{ + "id": "@kbn/core-http-browser-mocks", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/core-http-browser-mocks", + "id": "def-common.createHttpFetchError", + "type": "Function", + "tags": [], + "label": "createHttpFetchError", + "description": [], + "signature": [ + "(message: string, name: string, request: Request, response: Response | undefined, body: TResponseBody | undefined) => ", + "IHttpFetchError", + "" + ], + "path": "packages/core/http/core-http-browser-mocks/src/fetch_error.mock.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser-mocks", + "id": "def-common.createHttpFetchError.$1", + "type": "string", + "tags": [], + "label": "message", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/http/core-http-browser-mocks/src/fetch_error.mock.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-browser-mocks", + "id": "def-common.createHttpFetchError.$2", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/http/core-http-browser-mocks/src/fetch_error.mock.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-browser-mocks", + "id": "def-common.createHttpFetchError.$3", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "Request" + ], + "path": "packages/core/http/core-http-browser-mocks/src/fetch_error.mock.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-browser-mocks", + "id": "def-common.createHttpFetchError.$4", + "type": "Object", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "Response | undefined" + ], + "path": "packages/core/http/core-http-browser-mocks/src/fetch_error.mock.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "@kbn/core-http-browser-mocks", + "id": "def-common.createHttpFetchError.$5", + "type": "Uncategorized", + "tags": [], + "label": "body", + "description": [], + "signature": [ + "TResponseBody | undefined" + ], + "path": "packages/core/http/core-http-browser-mocks/src/fetch_error.mock.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/core-http-browser-mocks", + "id": "def-common.HttpSetupMock", + "type": "Type", + "tags": [], + "label": "HttpSetupMock", + "description": [], + "signature": [ + "{ basePath: ", + "IBasePath", + "; anonymousPaths: ", + "IAnonymousPaths", + "; externalUrl: ", + "IExternalUrl", + "; intercept: jest.MockInstance<() => void, [interceptor: ", + "HttpInterceptor", + "]>; fetch: jest.MockInstance, [options: ", + "HttpFetchOptionsWithPath", + "]>; delete: jest.MockInstance, [options: ", + "HttpFetchOptionsWithPath", + "]>; get: jest.MockInstance, [options: ", + "HttpFetchOptionsWithPath", + "]>; head: jest.MockInstance, [options: ", + "HttpFetchOptionsWithPath", + "]>; options: jest.MockInstance, [options: ", + "HttpFetchOptionsWithPath", + "]>; patch: jest.MockInstance, [options: ", + "HttpFetchOptionsWithPath", + "]>; post: jest.MockInstance, [options: ", + "HttpFetchOptionsWithPath", + "]>; put: jest.MockInstance, [options: ", + "HttpFetchOptionsWithPath", + "]>; addLoadingCountSource: jest.MockInstance]>; getLoadingCount$: jest.MockInstance<", + "Observable", + ", []>; } & ", + "HttpSetup", + " & { basePath: ", + "BasePath", + "; anonymousPaths: jest.Mocked<", + "IAnonymousPaths", + ">; }" + ], + "path": "packages/core/http/core-http-browser-mocks/src/http_service.mock.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [ + { + "parentPluginId": "@kbn/core-http-browser-mocks", + "id": "def-common.httpServiceMock", + "type": "Object", + "tags": [], + "label": "httpServiceMock", + "description": [], + "path": "packages/core/http/core-http-browser-mocks/src/http_service.mock.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser-mocks", + "id": "def-common.httpServiceMock.create", + "type": "Function", + "tags": [], + "label": "create", + "description": [], + "signature": [ + "({ basePath }?: { basePath?: string | undefined; }) => jest.Mocked<", + "PublicMethodsOf", + "<", + "HttpService", + ">>" + ], + "path": "packages/core/http/core-http-browser-mocks/src/http_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-browser-mocks", + "id": "def-common.httpServiceMock.create.$1", + "type": "Object", + "tags": [], + "label": "__0", + "description": [], + "signature": [ + "{ basePath?: string | undefined; }" + ], + "path": "packages/core/http/core-http-browser-mocks/src/http_service.mock.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/core-http-browser-mocks", + "id": "def-common.httpServiceMock.createSetupContract", + "type": "Function", + "tags": [], + "label": "createSetupContract", + "description": [], + "signature": [ + "({ basePath, publicBaseUrl, }?: { basePath?: string | undefined; publicBaseUrl?: string | undefined; }) => ", + { + "pluginId": "@kbn/core-http-browser-mocks", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserMocksPluginApi", + "section": "def-common.HttpSetupMock", + "text": "HttpSetupMock" + } + ], + "path": "packages/core/http/core-http-browser-mocks/src/http_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-browser-mocks", + "id": "def-common.httpServiceMock.createSetupContract.$1", + "type": "Object", + "tags": [], + "label": "__0", + "description": [], + "signature": [ + "{ basePath?: string | undefined; publicBaseUrl?: string | undefined; }" + ], + "path": "packages/core/http/core-http-browser-mocks/src/http_service.mock.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/core-http-browser-mocks", + "id": "def-common.httpServiceMock.createStartContract", + "type": "Function", + "tags": [], + "label": "createStartContract", + "description": [], + "signature": [ + "({ basePath, publicBaseUrl, }?: { basePath?: string | undefined; publicBaseUrl?: string | undefined; }) => ", + { + "pluginId": "@kbn/core-http-browser-mocks", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserMocksPluginApi", + "section": "def-common.HttpSetupMock", + "text": "HttpSetupMock" + } + ], + "path": "packages/core/http/core-http-browser-mocks/src/http_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-browser-mocks", + "id": "def-common.httpServiceMock.createStartContract.$1", + "type": "Object", + "tags": [], + "label": "__0", + "description": [], + "signature": [ + "{ basePath?: string | undefined; publicBaseUrl?: string | undefined; }" + ], + "path": "packages/core/http/core-http-browser-mocks/src/http_service.mock.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/core-http-browser-mocks", + "id": "def-common.httpServiceMock.createBasePath", + "type": "Function", + "tags": [], + "label": "createBasePath", + "description": [], + "signature": [ + "({ publicBaseUrl, serverBasePath, }?: { publicBaseUrl?: string | undefined; serverBasePath?: string | undefined; }) => jest.Mocked<", + "IBasePath", + ">" + ], + "path": "packages/core/http/core-http-browser-mocks/src/http_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-browser-mocks", + "id": "def-common.httpServiceMock.createBasePath.$1", + "type": "Object", + "tags": [], + "label": "__0", + "description": [], + "signature": [ + "{ publicBaseUrl?: string | undefined; serverBasePath?: string | undefined; }" + ], + "path": "packages/core/http/core-http-browser-mocks/src/base_path.mock.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + } + ] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_http_browser_mocks.mdx b/api_docs/kbn_core_http_browser_mocks.mdx new file mode 100644 index 0000000000000..df680225c6251 --- /dev/null +++ b/api_docs/kbn_core_http_browser_mocks.mdx @@ -0,0 +1,33 @@ +--- +id: kibKbnCoreHttpBrowserMocksPluginApi +slug: /kibana-dev-docs/api/kbn-core-http-browser-mocks +title: "@kbn/core-http-browser-mocks" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-http-browser-mocks plugin +date: 2022-07-13 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-browser-mocks'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnCoreHttpBrowserMocksObj from './kbn_core_http_browser_mocks.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 16 | 0 | 16 | 0 | + +## Common + +### Objects + + +### Functions + + +### Consts, variables and types + + diff --git a/api_docs/kbn_core_http_common.devdocs.json b/api_docs/kbn_core_http_common.devdocs.json new file mode 100644 index 0000000000000..5cfbe826982ee --- /dev/null +++ b/api_docs/kbn_core_http_common.devdocs.json @@ -0,0 +1,85 @@ +{ + "id": "@kbn/core-http-common", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [ + { + "parentPluginId": "@kbn/core-http-common", + "id": "def-common.IExternalUrlPolicy", + "type": "Interface", + "tags": [], + "label": "IExternalUrlPolicy", + "description": [ + "\nA policy describing whether access to an external destination is allowed." + ], + "path": "packages/core/http/core-http-common/src/external_url_policy.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-common", + "id": "def-common.IExternalUrlPolicy.allow", + "type": "boolean", + "tags": [], + "label": "allow", + "description": [ + "\nIndicates if this policy allows or denies access to the described destination." + ], + "path": "packages/core/http/core-http-common/src/external_url_policy.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-common", + "id": "def-common.IExternalUrlPolicy.host", + "type": "string", + "tags": [], + "label": "host", + "description": [ + "\nOptional host describing the external destination.\nMay be combined with `protocol`.\n" + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/http/core-http-common/src/external_url_policy.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-common", + "id": "def-common.IExternalUrlPolicy.protocol", + "type": "string", + "tags": [], + "label": "protocol", + "description": [ + "\nOptional protocol describing the external destination.\nMay be combined with `host`.\n" + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/http/core-http-common/src/external_url_policy.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_http_common.mdx b/api_docs/kbn_core_http_common.mdx new file mode 100644 index 0000000000000..97ec4742c8089 --- /dev/null +++ b/api_docs/kbn_core_http_common.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnCoreHttpCommonPluginApi +slug: /kibana-dev-docs/api/kbn-core-http-common +title: "@kbn/core-http-common" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-http-common plugin +date: 2022-07-13 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-common'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnCoreHttpCommonObj from './kbn_core_http_common.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 4 | 0 | 0 | 0 | + +## Common + +### Interfaces + + diff --git a/api_docs/kbn_core_http_server.devdocs.json b/api_docs/kbn_core_http_server.devdocs.json new file mode 100644 index 0000000000000..2179c6d1ea78d --- /dev/null +++ b/api_docs/kbn_core_http_server.devdocs.json @@ -0,0 +1,8537 @@ +{ + "id": "@kbn/core-http-server", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidationError", + "type": "Class", + "tags": [], + "label": "RouteValidationError", + "description": [ + "\nError to return when the validation is not successful." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteValidationError", + "text": "RouteValidationError" + }, + " extends ", + "SchemaTypeError" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidationError.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidationError.Unnamed.$1", + "type": "CompoundType", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "string | Error" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidationError.Unnamed.$2", + "type": "Array", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "string[]" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthRedirectedParams", + "type": "Interface", + "tags": [], + "label": "AuthRedirectedParams", + "description": [ + "\nResult of auth redirection." + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthRedirectedParams.headers", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [ + "\nHeaders to attach for auth redirect.\nMust include \"location\" header" + ], + "signature": [ + "{ location: string; } & ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ResponseHeaders", + "text": "ResponseHeaders" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthResultAuthenticated", + "type": "Interface", + "tags": [], + "label": "AuthResultAuthenticated", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthResultAuthenticated", + "text": "AuthResultAuthenticated" + }, + " extends ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthResultParams", + "text": "AuthResultParams" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthResultAuthenticated.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthResultType", + "text": "AuthResultType" + }, + ".authenticated" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthResultNotHandled", + "type": "Interface", + "tags": [], + "label": "AuthResultNotHandled", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthResultNotHandled.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthResultType", + "text": "AuthResultType" + }, + ".notHandled" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthResultParams", + "type": "Interface", + "tags": [], + "label": "AuthResultParams", + "description": [ + "\nResult of successful authentication." + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthResultParams.state", + "type": "Object", + "tags": [], + "label": "state", + "description": [ + "\nData to associate with an incoming request. Any downstream plugin may get access to the data." + ], + "signature": [ + "Record | undefined" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthResultParams.requestHeaders", + "type": "Object", + "tags": [], + "label": "requestHeaders", + "description": [ + "\nAuth specific headers to attach to a request object.\nUsed to perform a request to Elasticsearch on behalf of an authenticated user." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthHeaders", + "text": "AuthHeaders" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthResultParams.responseHeaders", + "type": "Object", + "tags": [], + "label": "responseHeaders", + "description": [ + "\nAuth specific headers to attach to a response object.\nUsed to send back authentication mechanism related headers to a client when needed." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthHeaders", + "text": "AuthHeaders" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthResultRedirected", + "type": "Interface", + "tags": [], + "label": "AuthResultRedirected", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthResultRedirected", + "text": "AuthResultRedirected" + }, + " extends ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthRedirectedParams", + "text": "AuthRedirectedParams" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthResultRedirected.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthResultType", + "text": "AuthResultType" + }, + ".redirected" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthToolkit", + "type": "Interface", + "tags": [], + "label": "AuthToolkit", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthToolkit.authenticated", + "type": "Function", + "tags": [], + "label": "authenticated", + "description": [ + "Authentication is successful with given credentials, allow request to pass through" + ], + "signature": [ + "(data?: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthResultParams", + "text": "AuthResultParams" + }, + " | undefined) => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthResult", + "text": "AuthResult" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthToolkit.authenticated.$1", + "type": "Object", + "tags": [], + "label": "data", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthResultParams", + "text": "AuthResultParams" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthToolkit.notHandled", + "type": "Function", + "tags": [], + "label": "notHandled", + "description": [ + "\nUser has no credentials.\nAllows user to access a resource when authRequired is 'optional'\nRejects a request when authRequired: true" + ], + "signature": [ + "() => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthResult", + "text": "AuthResult" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthToolkit.redirected", + "type": "Function", + "tags": [], + "label": "redirected", + "description": [ + "\nRedirects user to another location to complete authentication when authRequired: true\nAllows user to access a resource without redirection when authRequired: 'optional'" + ], + "signature": [ + "(headers: { location: string; } & ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ResponseHeaders", + "text": "ResponseHeaders" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthResult", + "text": "AuthResult" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthToolkit.redirected.$1", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [], + "signature": [ + "{ location: string; } & ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ResponseHeaders", + "text": "ResponseHeaders" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.CustomHttpResponseOptions", + "type": "Interface", + "tags": [], + "label": "CustomHttpResponseOptions", + "description": [ + "\nHTTP response parameters for a response with adjustable status code." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.CustomHttpResponseOptions.body", + "type": "Uncategorized", + "tags": [], + "label": "body", + "description": [ + "HTTP message to send to the client" + ], + "signature": [ + "T | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.CustomHttpResponseOptions.headers", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [ + "HTTP Headers with additional information about response" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ResponseHeaders", + "text": "ResponseHeaders" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.CustomHttpResponseOptions.bypassErrorFormat", + "type": "CompoundType", + "tags": [], + "label": "bypassErrorFormat", + "description": [ + "Bypass the default error formatting" + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.CustomHttpResponseOptions.statusCode", + "type": "number", + "tags": [], + "label": "statusCode", + "description": [], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.ErrorHttpResponseOptions", + "type": "Interface", + "tags": [], + "label": "ErrorHttpResponseOptions", + "description": [ + "\nHTTP response parameters" + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.ErrorHttpResponseOptions.body", + "type": "CompoundType", + "tags": [], + "label": "body", + "description": [ + "HTTP message to send to the client" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.ErrorHttpResponseOptions.headers", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [ + "HTTP Headers with additional information about response" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ResponseHeaders", + "text": "ResponseHeaders" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpAuth", + "type": "Interface", + "tags": [], + "label": "HttpAuth", + "description": [], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpAuth.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [ + "\nGets authentication state for a request. Returned by `auth` interceptor.\n{@link GetAuthState}" + ], + "signature": [ + "(request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => { status: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthStatus", + "text": "AuthStatus" + }, + "; state: T; }" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpAuth.get.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/auth_state.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpAuth.isAuthenticated", + "type": "Function", + "tags": [], + "label": "isAuthenticated", + "description": [ + "\nReturns authentication status for a request.\n{@link IsAuthenticated}" + ], + "signature": [ + "(request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => boolean" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpAuth.isAuthenticated.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/auth_state.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpResponseOptions", + "type": "Interface", + "tags": [], + "label": "HttpResponseOptions", + "description": [ + "\nHTTP response parameters" + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpResponseOptions.body", + "type": "CompoundType", + "tags": [], + "label": "body", + "description": [ + "HTTP message to send to the client" + ], + "signature": [ + "string | Record | ", + "Stream", + " | Buffer | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpResponseOptions.headers", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [ + "HTTP Headers with additional information about response" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ResponseHeaders", + "text": "ResponseHeaders" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpResponseOptions.bypassErrorFormat", + "type": "CompoundType", + "tags": [], + "label": "bypassErrorFormat", + "description": [ + "Bypass the default error formatting" + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServerInfo", + "type": "Interface", + "tags": [], + "label": "HttpServerInfo", + "description": [ + "\nInformation about what hostname, port, and protocol the server process is\nrunning on. Note that this may not match the URL that end-users access\nKibana at. For the public URL, see {@link BasePath.publicBaseUrl}." + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServerInfo.name", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "The name of the Kibana server" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServerInfo.hostname", + "type": "string", + "tags": [], + "label": "hostname", + "description": [ + "The hostname of the server" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServerInfo.port", + "type": "number", + "tags": [], + "label": "port", + "description": [ + "The port the server is listening on" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServerInfo.protocol", + "type": "CompoundType", + "tags": [], + "label": "protocol", + "description": [ + "The protocol used by the server" + ], + "signature": [ + "\"http\" | \"https\" | \"socket\"" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServicePreboot", + "type": "Interface", + "tags": [], + "label": "HttpServicePreboot", + "description": [ + "\nKibana HTTP Service provides an abstraction to work with the HTTP stack at the `preboot` stage. This functionality\nallows Kibana to serve user requests even before Kibana becomes fully operational. Only Core and `preboot` plugins\ncan define HTTP routes at this stage.\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.HttpServicePreboot", + "text": "HttpServicePreboot" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServicePreboot.registerRoutes", + "type": "Function", + "tags": [], + "label": "registerRoutes", + "description": [ + "\nProvides ability to acquire `preboot` {@link IRouter} instance for a particular top-level path and register handler\nfunctions for any number of nested routes.\n" + ], + "signature": [ + "(path: string, callback: (router: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IRouter", + "text": "IRouter" + }, + ") => void) => void" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServicePreboot.registerRoutes.$1", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServicePreboot.registerRoutes.$2", + "type": "Function", + "tags": [], + "label": "callback", + "description": [], + "signature": [ + "(router: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IRouter", + "text": "IRouter" + }, + ") => void" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServicePreboot.basePath", + "type": "Object", + "tags": [], + "label": "basePath", + "description": [ + "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IBasePath", + "text": "IBasePath" + } + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServicePreboot.getServerInfo", + "type": "Function", + "tags": [], + "label": "getServerInfo", + "description": [ + "\nProvides common {@link HttpServerInfo | information} about the running preboot http server." + ], + "signature": [ + "() => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.HttpServerInfo", + "text": "HttpServerInfo" + } + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup", + "type": "Interface", + "tags": [], + "label": "HttpServiceSetup", + "description": [ + "\nKibana HTTP Service provides own abstraction for work with HTTP stack.\nPlugins don't have direct access to `hapi` server and its primitives anymore. Moreover,\nplugins shouldn't rely on the fact that HTTP Service uses one or another library under the hood.\nThis gives the platform flexibility to upgrade or changing our internal HTTP stack without breaking plugins.\nIf the HTTP Service lacks functionality you need, we are happy to discuss and support your needs.\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.HttpServiceSetup", + "text": "HttpServiceSetup" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.createCookieSessionStorageFactory", + "type": "Function", + "tags": [], + "label": "createCookieSessionStorageFactory", + "description": [ + "\nCreates cookie based session storage factory {@link SessionStorageFactory}" + ], + "signature": [ + "(cookieOptions: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.SessionStorageCookieOptions", + "text": "SessionStorageCookieOptions" + }, + ") => Promise<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.SessionStorageFactory", + "text": "SessionStorageFactory" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.createCookieSessionStorageFactory.$1", + "type": "Object", + "tags": [], + "label": "cookieOptions", + "description": [ + "{@link SessionStorageCookieOptions } - options to configure created cookie session storage." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.SessionStorageCookieOptions", + "text": "SessionStorageCookieOptions" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.registerOnPreRouting", + "type": "Function", + "tags": [], + "label": "registerOnPreRouting", + "description": [ + "\nTo define custom logic to perform for incoming requests before server performs a route lookup.\n" + ], + "signature": [ + "(handler: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreRoutingHandler", + "text": "OnPreRoutingHandler" + }, + ") => void" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.registerOnPreRouting.$1", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link OnPreRoutingHandler } - function to call." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreRoutingHandler", + "text": "OnPreRoutingHandler" + } + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.registerOnPreAuth", + "type": "Function", + "tags": [], + "label": "registerOnPreAuth", + "description": [ + "\nTo define custom logic to perform for incoming requests before\nthe Auth interceptor performs a check that user has access to requested resources.\n" + ], + "signature": [ + "(handler: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreAuthHandler", + "text": "OnPreAuthHandler" + }, + ") => void" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.registerOnPreAuth.$1", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link OnPreRoutingHandler } - function to call." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreAuthHandler", + "text": "OnPreAuthHandler" + } + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "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": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthenticationHandler", + "text": "AuthenticationHandler" + }, + ") => void" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.registerAuth.$1", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link AuthenticationHandler } - function to perform authentication." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthenticationHandler", + "text": "AuthenticationHandler" + } + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "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": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPostAuthHandler", + "text": "OnPostAuthHandler" + }, + ") => void" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.registerOnPostAuth.$1", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link OnPostAuthHandler } - function to call." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPostAuthHandler", + "text": "OnPostAuthHandler" + } + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "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": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseHandler", + "text": "OnPreResponseHandler" + }, + ") => void" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.registerOnPreResponse.$1", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link OnPreResponseHandler } - function to call." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseHandler", + "text": "OnPreResponseHandler" + } + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.basePath", + "type": "Object", + "tags": [], + "label": "basePath", + "description": [ + "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IBasePath", + "text": "IBasePath" + } + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.csp", + "type": "Object", + "tags": [], + "label": "csp", + "description": [ + "\nThe CSP config used for Kibana." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ICspConfig", + "text": "ICspConfig" + } + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.createRouter", + "type": "Function", + "tags": [], + "label": "createRouter", + "description": [ + "\nProvides ability to declare a handler function for a particular path and HTTP request method.\n" + ], + "signature": [ + "() => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IRouter", + "text": "IRouter" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.registerRouteHandlerContext", + "type": "Function", + "tags": [], + "label": "registerRouteHandlerContext", + "description": [ + "\nRegister a context provider for a route handler." + ], + "signature": [ + ">(contextName: ContextName, provider: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IContextProvider", + "text": "IContextProvider" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IContextContainer", + "text": "IContextContainer" + } + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.registerRouteHandlerContext.$1", + "type": "Uncategorized", + "tags": [], + "label": "contextName", + "description": [], + "signature": [ + "ContextName" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.registerRouteHandlerContext.$2", + "type": "Function", + "tags": [], + "label": "provider", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IContextProvider", + "text": "IContextProvider" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.getServerInfo", + "type": "Function", + "tags": [], + "label": "getServerInfo", + "description": [ + "\nProvides common {@link HttpServerInfo | information} about the running http server." + ], + "signature": [ + "() => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.HttpServerInfo", + "text": "HttpServerInfo" + } + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceStart", + "type": "Interface", + "tags": [], + "label": "HttpServiceStart", + "description": [], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceStart.basePath", + "type": "Object", + "tags": [], + "label": "basePath", + "description": [ + "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IBasePath", + "text": "IBasePath" + } + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceStart.auth", + "type": "Object", + "tags": [], + "label": "auth", + "description": [ + "\nAuth status.\nSee {@link HttpAuth}" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.HttpAuth", + "text": "HttpAuth" + } + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceStart.getServerInfo", + "type": "Function", + "tags": [], + "label": "getServerInfo", + "description": [ + "\nProvides common {@link HttpServerInfo | information} about the running http server." + ], + "signature": [ + "() => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.HttpServerInfo", + "text": "HttpServerInfo" + } + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IAuthHeadersStorage", + "type": "Interface", + "tags": [], + "label": "IAuthHeadersStorage", + "description": [], + "path": "packages/core/http/core-http-server/src/auth_headers.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IAuthHeadersStorage.set", + "type": "Function", + "tags": [], + "label": "set", + "description": [], + "signature": [ + "(request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", headers: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthHeaders", + "text": "AuthHeaders" + }, + ") => void" + ], + "path": "packages/core/http/core-http-server/src/auth_headers.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IAuthHeadersStorage.set.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/auth_headers.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IAuthHeadersStorage.set.$2", + "type": "Object", + "tags": [], + "label": "headers", + "description": [], + "signature": [ + "{ [x: string]: string | string[]; }" + ], + "path": "packages/core/http/core-http-server/src/auth_headers.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IAuthHeadersStorage.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [], + "signature": [ + "(request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthHeaders", + "text": "AuthHeaders" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/auth_headers.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IAuthHeadersStorage.get.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/auth_headers.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IBasePath", + "type": "Interface", + "tags": [], + "label": "IBasePath", + "description": [ + "\nAccess or manipulate the Kibana base path\n" + ], + "path": "packages/core/http/core-http-server/src/base_path.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IBasePath.serverBasePath", + "type": "string", + "tags": [], + "label": "serverBasePath", + "description": [ + "\nreturns the server's basePath.\n\nSee {@link IBasePath.get} for getting the basePath value for a specific request" + ], + "path": "packages/core/http/core-http-server/src/base_path.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IBasePath.publicBaseUrl", + "type": "string", + "tags": [], + "label": "publicBaseUrl", + "description": [ + "\nThe server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the\n{@link IBasePath.serverBasePath}.\n" + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/http/core-http-server/src/base_path.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IBasePath.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [ + "\nreturns `basePath` value, specific for an incoming request." + ], + "signature": [ + "(request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => string" + ], + "path": "packages/core/http/core-http-server/src/base_path.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IBasePath.get.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/base_path.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IBasePath.set", + "type": "Function", + "tags": [], + "label": "set", + "description": [ + "\nsets `basePath` value, specific for an incoming request." + ], + "signature": [ + "(request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", requestSpecificBasePath: string) => void" + ], + "path": "packages/core/http/core-http-server/src/base_path.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IBasePath.set.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/base_path.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IBasePath.set.$2", + "type": "string", + "tags": [], + "label": "requestSpecificBasePath", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/http/core-http-server/src/base_path.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IBasePath.prepend", + "type": "Function", + "tags": [], + "label": "prepend", + "description": [ + "\nPrepends `path` with the basePath." + ], + "signature": [ + "(path: string) => string" + ], + "path": "packages/core/http/core-http-server/src/base_path.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IBasePath.prepend.$1", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/http/core-http-server/src/base_path.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IBasePath.remove", + "type": "Function", + "tags": [], + "label": "remove", + "description": [ + "\nRemoves the prepended basePath from the `path`." + ], + "signature": [ + "(path: string) => string" + ], + "path": "packages/core/http/core-http-server/src/base_path.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IBasePath.remove.$1", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/http/core-http-server/src/base_path.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IContextContainer", + "type": "Interface", + "tags": [], + "label": "IContextContainer", + "description": [ + "\nAn object that handles registration of context providers and configuring handlers with context.\n" + ], + "path": "packages/core/http/core-http-server/src/router/context_container.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IContextContainer.registerContext", + "type": "Function", + "tags": [], + "label": "registerContext", + "description": [ + "\nRegister a new context provider.\n" + ], + "signature": [ + "(pluginOpaqueId: symbol, contextName: ContextName, provider: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IContextProvider", + "text": "IContextProvider" + }, + ") => this" + ], + "path": "packages/core/http/core-http-server/src/router/context_container.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IContextContainer.registerContext.$1", + "type": "Uncategorized", + "tags": [], + "label": "pluginOpaqueId", + "description": [ + "- The plugin opaque ID for the plugin that registers this context." + ], + "signature": [ + "symbol" + ], + "path": "packages/core/http/core-http-server/src/router/context_container.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IContextContainer.registerContext.$2", + "type": "Uncategorized", + "tags": [], + "label": "contextName", + "description": [ + "- The key of the `TContext` object this provider supplies the value for." + ], + "signature": [ + "ContextName" + ], + "path": "packages/core/http/core-http-server/src/router/context_container.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IContextContainer.registerContext.$3", + "type": "Function", + "tags": [], + "label": "provider", + "description": [ + "- A {@link IContextProvider } to be called each time a new context is created." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IContextProvider", + "text": "IContextProvider" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/context_container.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "The {@link IContextContainer } for method chaining." + ] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IContextContainer.createHandler", + "type": "Function", + "tags": [], + "label": "createHandler", + "description": [ + "\nCreate a new handler function pre-wired to context for the plugin.\n" + ], + "signature": [ + "(pluginOpaqueId: symbol, handler: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + ") => (request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaResponseFactory", + "text": "KibanaResponseFactory" + }, + ") => Promise<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/router/context_container.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IContextContainer.createHandler.$1", + "type": "Uncategorized", + "tags": [], + "label": "pluginOpaqueId", + "description": [ + "- The plugin opaque ID for the plugin that registers this handler." + ], + "signature": [ + "symbol" + ], + "path": "packages/core/http/core-http-server/src/router/context_container.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IContextContainer.createHandler.$2", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "- Handler function to pass context object to." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/context_container.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "A function that takes `RequestHandler` parameters, calls `handler` with a new context, and returns a Promise of\nthe `handler` return value." + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.ICspConfig", + "type": "Interface", + "tags": [], + "label": "ICspConfig", + "description": [ + "\nCSP configuration for use in Kibana." + ], + "path": "packages/core/http/core-http-server/src/csp.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.ICspConfig.strict", + "type": "boolean", + "tags": [], + "label": "strict", + "description": [ + "\nSpecify whether browsers that do not support CSP should be\nable to use Kibana. Use `true` to block and `false` to allow." + ], + "path": "packages/core/http/core-http-server/src/csp.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.ICspConfig.warnLegacyBrowsers", + "type": "boolean", + "tags": [], + "label": "warnLegacyBrowsers", + "description": [ + "\nSpecify whether users with legacy browsers should be warned\nabout their lack of Kibana security compliance." + ], + "path": "packages/core/http/core-http-server/src/csp.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.ICspConfig.disableEmbedding", + "type": "boolean", + "tags": [], + "label": "disableEmbedding", + "description": [ + "\nWhether or not embedding (using iframes) should be allowed by the CSP. If embedding is disabled, a restrictive 'frame-ancestors' rule will be added to the default CSP rules." + ], + "path": "packages/core/http/core-http-server/src/csp.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.ICspConfig.header", + "type": "string", + "tags": [], + "label": "header", + "description": [ + "\nThe CSP rules in a formatted directives string for use\nin a `Content-Security-Policy` header." + ], + "path": "packages/core/http/core-http-server/src/csp.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IExternalUrlConfig", + "type": "Interface", + "tags": [], + "label": "IExternalUrlConfig", + "description": [ + "\nExternal Url configuration for use in Kibana." + ], + "path": "packages/core/http/core-http-server/src/external_url.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IExternalUrlConfig.policy", + "type": "Array", + "tags": [], + "label": "policy", + "description": [ + "\nA set of policies describing which external urls are allowed." + ], + "signature": [ + "IExternalUrlPolicy", + "[]" + ], + "path": "packages/core/http/core-http-server/src/external_url.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaResponse", + "type": "Interface", + "tags": [], + "label": "IKibanaResponse", + "description": [ + "\nA response data object, expected to returned as a result of {@link RequestHandler} execution" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaResponse.status", + "type": "number", + "tags": [], + "label": "status", + "description": [], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaResponse.payload", + "type": "Uncategorized", + "tags": [], + "label": "payload", + "description": [], + "signature": [ + "T | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaResponse.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + } + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaSocket", + "type": "Interface", + "tags": [], + "label": "IKibanaSocket", + "description": [ + "\nA tiny abstraction for TCP socket." + ], + "path": "packages/core/http/core-http-server/src/router/socket.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaSocket.getPeerCertificate", + "type": "Function", + "tags": [], + "label": "getPeerCertificate", + "description": [], + "signature": [ + "{ (detailed: true): ", + "DetailedPeerCertificate", + " | null; (detailed: false): ", + "PeerCertificate", + " | null; (detailed?: boolean | undefined): ", + "PeerCertificate", + " | ", + "DetailedPeerCertificate", + " | null; }" + ], + "path": "packages/core/http/core-http-server/src/router/socket.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaSocket.getPeerCertificate.$1", + "type": "boolean", + "tags": [], + "label": "detailed", + "description": [], + "signature": [ + "true" + ], + "path": "packages/core/http/core-http-server/src/router/socket.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaSocket.getPeerCertificate", + "type": "Function", + "tags": [], + "label": "getPeerCertificate", + "description": [], + "signature": [ + "{ (detailed: true): ", + "DetailedPeerCertificate", + " | null; (detailed: false): ", + "PeerCertificate", + " | null; (detailed?: boolean | undefined): ", + "PeerCertificate", + " | ", + "DetailedPeerCertificate", + " | null; }" + ], + "path": "packages/core/http/core-http-server/src/router/socket.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaSocket.getPeerCertificate.$1", + "type": "boolean", + "tags": [], + "label": "detailed", + "description": [], + "signature": [ + "false" + ], + "path": "packages/core/http/core-http-server/src/router/socket.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaSocket.getPeerCertificate", + "type": "Function", + "tags": [], + "label": "getPeerCertificate", + "description": [ + "\nReturns an object representing the peer's certificate.\nThe returned object has some properties corresponding to the field of the certificate.\nIf detailed argument is true the full chain with issuer property will be returned,\nif false only the top certificate without issuer property.\nIf the peer does not provide a certificate, it returns null." + ], + "signature": [ + "{ (detailed: true): ", + "DetailedPeerCertificate", + " | null; (detailed: false): ", + "PeerCertificate", + " | null; (detailed?: boolean | undefined): ", + "PeerCertificate", + " | ", + "DetailedPeerCertificate", + " | null; }" + ], + "path": "packages/core/http/core-http-server/src/router/socket.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaSocket.getPeerCertificate.$1", + "type": "CompoundType", + "tags": [], + "label": "detailed", + "description": [ + "- If true; the full chain with issuer property will be returned." + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/socket.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "An object representing the peer's certificate." + ] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaSocket.getProtocol", + "type": "Function", + "tags": [], + "label": "getProtocol", + "description": [ + "\nReturns a string containing the negotiated SSL/TLS protocol version of the current connection. The value 'unknown' will be returned for\nconnected sockets that have not completed the handshaking process. The value null will be returned for server sockets or disconnected\nclient sockets. See https://www.openssl.org/docs/man1.0.2/ssl/SSL_get_version.html for more information." + ], + "signature": [ + "() => string | null" + ], + "path": "packages/core/http/core-http-server/src/router/socket.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaSocket.renegotiate", + "type": "Function", + "tags": [], + "label": "renegotiate", + "description": [ + "\nRenegotiates a connection to obtain the peer's certificate. This cannot be used when the protocol version is TLSv1.3." + ], + "signature": [ + "(options: { rejectUnauthorized?: boolean | undefined; requestCert?: boolean | undefined; }) => Promise" + ], + "path": "packages/core/http/core-http-server/src/router/socket.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaSocket.renegotiate.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "path": "packages/core/http/core-http-server/src/router/socket.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaSocket.renegotiate.$1.rejectUnauthorized", + "type": "CompoundType", + "tags": [], + "label": "rejectUnauthorized", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/socket.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaSocket.renegotiate.$1.requestCert", + "type": "CompoundType", + "tags": [], + "label": "requestCert", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/socket.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [ + "A Promise that will be resolved if renegotiation succeeded, or will be rejected if renegotiation failed." + ] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaSocket.authorized", + "type": "CompoundType", + "tags": [], + "label": "authorized", + "description": [ + "\nIndicates whether or not the peer certificate was signed by one of the specified CAs. When TLS\nisn't used the value is `undefined`." + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/socket.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaSocket.authorizationError", + "type": "Object", + "tags": [], + "label": "authorizationError", + "description": [ + "\nThe reason why the peer's certificate has not been verified. This property becomes available\nonly when `authorized` is `false`." + ], + "signature": [ + "Error | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/socket.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter", + "type": "Interface", + "tags": [], + "label": "IRouter", + "description": [ + "\nRegisters route handlers for specified resource path and method.\nSee {@link RouteConfig} and {@link RequestHandler} for more information about arguments to route registrations.\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IRouter", + "text": "IRouter" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.routerPath", + "type": "string", + "tags": [], + "label": "routerPath", + "description": [ + "\nResulted path" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [ + "\nRegister a route handler for `GET` request." + ], + "signature": [ + "(route: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + ", handler: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + ") => void" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.get.$1", + "type": "Object", + "tags": [], + "label": "route", + "description": [ + "{@link RouteConfig } - a route configuration." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.get.$2", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link RequestHandler } - a function to call to respond to an incoming request" + ], + "signature": [ + "(context: Context, request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaResponseFactory", + "text": "KibanaResponseFactory" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | Promise<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.get.$2.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.get.$2.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.get.$2.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + } + ] + } + ] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.post", + "type": "Function", + "tags": [], + "label": "post", + "description": [ + "\nRegister a route handler for `POST` request." + ], + "signature": [ + "(route: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + ", handler: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + ") => void" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.post.$1", + "type": "Object", + "tags": [], + "label": "route", + "description": [ + "{@link RouteConfig } - a route configuration." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.post.$2", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link RequestHandler } - a function to call to respond to an incoming request" + ], + "signature": [ + "(context: Context, request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaResponseFactory", + "text": "KibanaResponseFactory" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | Promise<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.post.$2.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.post.$2.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.post.$2.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + } + ] + } + ] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.put", + "type": "Function", + "tags": [], + "label": "put", + "description": [ + "\nRegister a route handler for `PUT` request." + ], + "signature": [ + "(route: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + ", handler: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + ") => void" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.put.$1", + "type": "Object", + "tags": [], + "label": "route", + "description": [ + "{@link RouteConfig } - a route configuration." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.put.$2", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link RequestHandler } - a function to call to respond to an incoming request" + ], + "signature": [ + "(context: Context, request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaResponseFactory", + "text": "KibanaResponseFactory" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | Promise<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.put.$2.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.put.$2.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.put.$2.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + } + ] + } + ] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.patch", + "type": "Function", + "tags": [], + "label": "patch", + "description": [ + "\nRegister a route handler for `PATCH` request." + ], + "signature": [ + "(route: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + ", handler: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + ") => void" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.patch.$1", + "type": "Object", + "tags": [], + "label": "route", + "description": [ + "{@link RouteConfig } - a route configuration." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.patch.$2", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link RequestHandler } - a function to call to respond to an incoming request" + ], + "signature": [ + "(context: Context, request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaResponseFactory", + "text": "KibanaResponseFactory" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | Promise<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.patch.$2.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.patch.$2.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.patch.$2.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + } + ] + } + ] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.delete", + "type": "Function", + "tags": [], + "label": "delete", + "description": [ + "\nRegister a route handler for `DELETE` request." + ], + "signature": [ + "(route: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + ", handler: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + ") => void" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.delete.$1", + "type": "Object", + "tags": [], + "label": "route", + "description": [ + "{@link RouteConfig } - a route configuration." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.delete.$2", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link RequestHandler } - a function to call to respond to an incoming request" + ], + "signature": [ + "(context: Context, request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaResponseFactory", + "text": "KibanaResponseFactory" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | Promise<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.delete.$2.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.delete.$2.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.delete.$2.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + } + ] + } + ] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.handleLegacyErrors", + "type": "Function", + "tags": [], + "label": "handleLegacyErrors", + "description": [ + "\nWrap a router handler to catch and converts legacy boom errors to proper custom errors." + ], + "signature": [ + "(handler: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.handleLegacyErrors.$1", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link RequestHandler } - a route handler to wrap" + ], + "signature": [ + "(context: Context, request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ResponseFactory) => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | Promise<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.handleLegacyErrors.$1.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.handleLegacyErrors.$1.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.handleLegacyErrors.$1.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + } + ] + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaErrorResponseFactory", + "type": "Interface", + "tags": [], + "label": "KibanaErrorResponseFactory", + "description": [], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaErrorResponseFactory.badRequest", + "type": "Function", + "tags": [], + "label": "badRequest", + "description": [ + "\nThe server cannot process the request due to something that is perceived to be a client error.\nStatus code: `400`." + ], + "signature": [ + "(options?: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + " | undefined) => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaErrorResponseFactory.badRequest.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- {@link HttpResponseOptions } configures HTTP response headers, error message and other error details to pass to the client" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaErrorResponseFactory.unauthorized", + "type": "Function", + "tags": [], + "label": "unauthorized", + "description": [ + "\nThe request cannot be applied because it lacks valid authentication credentials for the target resource.\nStatus code: `401`." + ], + "signature": [ + "(options?: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + " | undefined) => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaErrorResponseFactory.unauthorized.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- {@link HttpResponseOptions } configures HTTP response headers, error message and other error details to pass to the client" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaErrorResponseFactory.forbidden", + "type": "Function", + "tags": [], + "label": "forbidden", + "description": [ + "\nServer cannot grant access to a resource.\nStatus code: `403`." + ], + "signature": [ + "(options?: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + " | undefined) => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaErrorResponseFactory.forbidden.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- {@link HttpResponseOptions } configures HTTP response headers, error message and other error details to pass to the client" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaErrorResponseFactory.notFound", + "type": "Function", + "tags": [], + "label": "notFound", + "description": [ + "\nServer cannot find a current representation for the target resource.\nStatus code: `404`." + ], + "signature": [ + "(options?: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + " | undefined) => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaErrorResponseFactory.notFound.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- {@link HttpResponseOptions } configures HTTP response headers, error message and other error details to pass to the client" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaErrorResponseFactory.conflict", + "type": "Function", + "tags": [], + "label": "conflict", + "description": [ + "\nThe request could not be completed due to a conflict with the current state of the target resource.\nStatus code: `409`." + ], + "signature": [ + "(options?: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + " | undefined) => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaErrorResponseFactory.conflict.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- {@link HttpResponseOptions } configures HTTP response headers, error message and other error details to pass to the client" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaErrorResponseFactory.customError", + "type": "Function", + "tags": [], + "label": "customError", + "description": [ + "\nCreates an error response with defined status code and payload." + ], + "signature": [ + "(options: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + "Stream", + " | Buffer | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaErrorResponseFactory.customError.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- {@link CustomHttpResponseOptions } configures HTTP response headers, error message and other error details to pass to the client" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + "Stream", + " | Buffer | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRedirectionResponseFactory", + "type": "Interface", + "tags": [], + "label": "KibanaRedirectionResponseFactory", + "description": [], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRedirectionResponseFactory.redirected", + "type": "Function", + "tags": [], + "label": "redirected", + "description": [ + "\nRedirect to a different URI.\nStatus code: `302`." + ], + "signature": [ + "(options: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRedirectionResponseFactory.redirected.$1", + "type": "CompoundType", + "tags": [], + "label": "options", + "description": [ + "- {@link RedirectResponseOptions } configures HTTP response body & headers.\nExpects `location` header to be set." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + } + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequest", + "type": "Interface", + "tags": [], + "label": "KibanaRequest", + "description": [ + "\nKibana specific abstraction for an incoming request." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequest.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "\nA identifier to identify this request.\n" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequest.uuid", + "type": "string", + "tags": [], + "label": "uuid", + "description": [ + "\nA UUID to identify this request.\n" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequest.url", + "type": "Object", + "tags": [], + "label": "url", + "description": [ + "a WHATWG URL standard object." + ], + "signature": [ + "URL" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequest.route", + "type": "Object", + "tags": [], + "label": "route", + "description": [ + "matched route details" + ], + "signature": [ + "{ readonly path: string; readonly method: ", + "RecursiveReadonly", + "; readonly options: ", + "RecursiveReadonly", + "<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequestRouteOptions", + "text": "KibanaRequestRouteOptions" + }, + ">; }" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequest.headers", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [ + "\nReadonly copy of incoming request headers." + ], + "signature": [ + "{ warning?: string | string[] | undefined; from?: string | string[] | undefined; date?: string | string[] | undefined; expires?: string | string[] | undefined; range?: string | string[] | undefined; origin?: string | string[] | undefined; location?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; etag?: string | string[] | undefined; authorization?: string | string[] | undefined; connection?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequest.isSystemRequest", + "type": "boolean", + "tags": [], + "label": "isSystemRequest", + "description": [ + "\nWhether or not the request is a \"system request\" rather than an application-level request.\nCan be set on the client using the `HttpFetchOptions#asSystemRequest` option." + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequest.socket", + "type": "Object", + "tags": [], + "label": "socket", + "description": [ + "\nThe socket associated with this request.\nSee {@link IKibanaSocket}." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaSocket", + "text": "IKibanaSocket" + } + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequest.events", + "type": "Object", + "tags": [], + "label": "events", + "description": [ + "\nAllow to listen to events bound to this request.\nSee {@link KibanaRequestEvents}." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequestEvents", + "text": "KibanaRequestEvents" + } + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequest.auth", + "type": "Object", + "tags": [], + "label": "auth", + "description": [ + "\nThe auth status of this request.\nSee {@link KibanaRequestAuth}." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequestAuth", + "text": "KibanaRequestAuth" + } + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequest.rewrittenUrl", + "type": "Object", + "tags": [], + "label": "rewrittenUrl", + "description": [ + "\nURL rewritten in onPreRouting request interceptor." + ], + "signature": [ + "URL", + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequest.params", + "type": "Uncategorized", + "tags": [], + "label": "params", + "description": [ + "\nThe path parameter of this request." + ], + "signature": [ + "Params" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequest.query", + "type": "Uncategorized", + "tags": [], + "label": "query", + "description": [ + "\nThe query parameter of this request." + ], + "signature": [ + "Query" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequest.body", + "type": "Uncategorized", + "tags": [], + "label": "body", + "description": [ + "\nThe body payload of this request." + ], + "signature": [ + "Body" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequestAuth", + "type": "Interface", + "tags": [], + "label": "KibanaRequestAuth", + "description": [ + "\nAuth status for this request." + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequestAuth.isAuthenticated", + "type": "boolean", + "tags": [], + "label": "isAuthenticated", + "description": [ + "true if the request has been successfully authenticated, false otherwise." + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequestEvents", + "type": "Interface", + "tags": [], + "label": "KibanaRequestEvents", + "description": [ + "\nRequest events." + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequestEvents.aborted$", + "type": "Object", + "tags": [], + "label": "aborted$", + "description": [ + "\nObservable that emits once if and when the request has been aborted." + ], + "signature": [ + "Observable", + "" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequestEvents.completed$", + "type": "Object", + "tags": [], + "label": "completed$", + "description": [ + "\nObservable that emits once if and when the request has been completely handled.\n" + ], + "signature": [ + "Observable", + "" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequestRoute", + "type": "Interface", + "tags": [], + "label": "KibanaRequestRoute", + "description": [ + "\nRequest specific route information exposed to a handler." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequestRoute", + "text": "KibanaRequestRoute" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequestRoute.path", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequestRoute.method", + "type": "Uncategorized", + "tags": [], + "label": "method", + "description": [], + "signature": [ + "Method" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequestRoute.options", + "type": "Uncategorized", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "Method extends \"options\" | \"get\" ? Required, \"body\">> : Required<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfigOptions", + "text": "RouteConfigOptions" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequestState", + "type": "Interface", + "tags": [], + "label": "KibanaRequestState", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequestState", + "text": "KibanaRequestState" + }, + " extends ", + "RequestApplicationState" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequestState.requestId", + "type": "string", + "tags": [], + "label": "requestId", + "description": [], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequestState.requestUuid", + "type": "string", + "tags": [], + "label": "requestUuid", + "description": [], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequestState.rewrittenUrl", + "type": "Object", + "tags": [], + "label": "rewrittenUrl", + "description": [], + "signature": [ + "URL", + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequestState.traceId", + "type": "string", + "tags": [], + "label": "traceId", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRouteOptions", + "type": "Interface", + "tags": [], + "label": "KibanaRouteOptions", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRouteOptions", + "text": "KibanaRouteOptions" + }, + " extends ", + "RouteOptionsApp" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRouteOptions.xsrfRequired", + "type": "boolean", + "tags": [], + "label": "xsrfRequired", + "description": [], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaSuccessResponseFactory", + "type": "Interface", + "tags": [], + "label": "KibanaSuccessResponseFactory", + "description": [], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaSuccessResponseFactory.ok", + "type": "Function", + "tags": [], + "label": "ok", + "description": [ + "\nThe request has succeeded.\nStatus code: `200`." + ], + "signature": [ + "(options?: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + " | undefined) => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaSuccessResponseFactory.ok.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- {@link HttpResponseOptions } configures HTTP response body & headers." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaSuccessResponseFactory.accepted", + "type": "Function", + "tags": [], + "label": "accepted", + "description": [ + "\nThe request has been accepted for processing.\nStatus code: `202`." + ], + "signature": [ + "(options?: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + " | undefined) => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaSuccessResponseFactory.accepted.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- {@link HttpResponseOptions } configures HTTP response body & headers." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaSuccessResponseFactory.noContent", + "type": "Function", + "tags": [], + "label": "noContent", + "description": [ + "\nThe server has successfully fulfilled the request and that there is no additional content to send in the response payload body.\nStatus code: `204`." + ], + "signature": [ + "(options?: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + " | undefined) => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaSuccessResponseFactory.noContent.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- {@link HttpResponseOptions } configures HTTP response body & headers." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPostAuthNextResult", + "type": "Interface", + "tags": [], + "label": "OnPostAuthNextResult", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/on_post_auth.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPostAuthNextResult.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPostAuthResultType", + "text": "OnPostAuthResultType" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_post_auth.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPostAuthToolkit", + "type": "Interface", + "tags": [], + "label": "OnPostAuthToolkit", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/on_post_auth.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPostAuthToolkit.next", + "type": "Function", + "tags": [], + "label": "next", + "description": [ + "To pass request to the next handler" + ], + "signature": [ + "() => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPostAuthNextResult", + "text": "OnPostAuthNextResult" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_post_auth.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreAuthNextResult", + "type": "Interface", + "tags": [], + "label": "OnPreAuthNextResult", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_auth.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreAuthNextResult.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreAuthResultType", + "text": "OnPreAuthResultType" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_auth.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreAuthToolkit", + "type": "Interface", + "tags": [], + "label": "OnPreAuthToolkit", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_auth.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreAuthToolkit.next", + "type": "Function", + "tags": [], + "label": "next", + "description": [ + "To pass request to the next handler" + ], + "signature": [ + "() => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreAuthNextResult", + "text": "OnPreAuthNextResult" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_auth.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseExtensions", + "type": "Interface", + "tags": [], + "label": "OnPreResponseExtensions", + "description": [ + "\nAdditional data to extend a response." + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseExtensions.headers", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [ + "additional headers to attach to the response" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ResponseHeaders", + "text": "ResponseHeaders" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseInfo", + "type": "Interface", + "tags": [], + "label": "OnPreResponseInfo", + "description": [ + "\nResponse status code." + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseInfo.statusCode", + "type": "number", + "tags": [], + "label": "statusCode", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseRender", + "type": "Interface", + "tags": [], + "label": "OnPreResponseRender", + "description": [ + "\nAdditional data to extend a response when rendering a new body" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseRender.headers", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [ + "additional headers to attach to the response" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ResponseHeaders", + "text": "ResponseHeaders" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseRender.body", + "type": "string", + "tags": [], + "label": "body", + "description": [ + "the body to use in the response" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseResultNext", + "type": "Interface", + "tags": [], + "label": "OnPreResponseResultNext", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseResultNext.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseResultType", + "text": "OnPreResponseResultType" + }, + ".next" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseResultNext.headers", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ResponseHeaders", + "text": "ResponseHeaders" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseResultRender", + "type": "Interface", + "tags": [], + "label": "OnPreResponseResultRender", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseResultRender.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseResultType", + "text": "OnPreResponseResultType" + }, + ".render" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseResultRender.body", + "type": "string", + "tags": [], + "label": "body", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseResultRender.headers", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ResponseHeaders", + "text": "ResponseHeaders" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseToolkit", + "type": "Interface", + "tags": [], + "label": "OnPreResponseToolkit", + "description": [ + "\nA tool set defining an outcome of OnPreResponse interceptor for incoming request." + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseToolkit.render", + "type": "Function", + "tags": [], + "label": "render", + "description": [ + "To override the response with a different body" + ], + "signature": [ + "(responseRender: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseRender", + "text": "OnPreResponseRender" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseResult", + "text": "OnPreResponseResult" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseToolkit.render.$1", + "type": "Object", + "tags": [], + "label": "responseRender", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseRender", + "text": "OnPreResponseRender" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseToolkit.next", + "type": "Function", + "tags": [], + "label": "next", + "description": [ + "To pass request to the next handler" + ], + "signature": [ + "(responseExtensions?: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseExtensions", + "text": "OnPreResponseExtensions" + }, + " | undefined) => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseResult", + "text": "OnPreResponseResult" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseToolkit.next.$1", + "type": "Object", + "tags": [], + "label": "responseExtensions", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseExtensions", + "text": "OnPreResponseExtensions" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreRoutingResultNext", + "type": "Interface", + "tags": [], + "label": "OnPreRoutingResultNext", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_routing.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreRoutingResultNext.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreRoutingResultType", + "text": "OnPreRoutingResultType" + }, + ".next" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_routing.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreRoutingResultRewriteUrl", + "type": "Interface", + "tags": [], + "label": "OnPreRoutingResultRewriteUrl", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_routing.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreRoutingResultRewriteUrl.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreRoutingResultType", + "text": "OnPreRoutingResultType" + }, + ".rewriteUrl" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_routing.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreRoutingResultRewriteUrl.url", + "type": "string", + "tags": [], + "label": "url", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_routing.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreRoutingToolkit", + "type": "Interface", + "tags": [], + "label": "OnPreRoutingToolkit", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_routing.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreRoutingToolkit.next", + "type": "Function", + "tags": [], + "label": "next", + "description": [ + "To pass request to the next handler" + ], + "signature": [ + "() => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreRoutingResult", + "text": "OnPreRoutingResult" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_routing.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreRoutingToolkit.rewriteUrl", + "type": "Function", + "tags": [], + "label": "rewriteUrl", + "description": [ + "Rewrite requested resources url before is was authenticated and routed to a handler" + ], + "signature": [ + "(url: string) => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreRoutingResult", + "text": "OnPreRoutingResult" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_routing.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreRoutingToolkit.rewriteUrl.$1", + "type": "string", + "tags": [], + "label": "url", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_routing.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RequestHandlerContextBase", + "type": "Interface", + "tags": [], + "label": "RequestHandlerContextBase", + "description": [ + "\nBase, abstract type for request handler contexts." + ], + "path": "packages/core/http/core-http-server/src/router/request_handler_context.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RequestHandlerContextBase.resolve", + "type": "Function", + "tags": [], + "label": "resolve", + "description": [ + "\nAwait all the specified context parts and return them.\n" + ], + "signature": [ + ">(parts: T[]) => Promise<", + "AwaitedProperties", + ">>" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler_context.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RequestHandlerContextBase.resolve.$1", + "type": "Array", + "tags": [], + "label": "parts", + "description": [], + "signature": [ + "T[]" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler_context.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteConfig", + "type": "Interface", + "tags": [], + "label": "RouteConfig", + "description": [ + "\nRoute specific configuration." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteConfig.path", + "type": "string", + "tags": [], + "label": "path", + "description": [ + "\nThe endpoint _within_ the router path to register the route.\n" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteConfig.validate", + "type": "CompoundType", + "tags": [], + "label": "validate", + "description": [ + "\nA schema created with `@kbn/config-schema` that every request will be validated against.\n" + ], + "signature": [ + "false | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteValidatorFullConfig", + "text": "RouteValidatorFullConfig" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteConfig.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "\nAdditional route options {@link RouteConfigOptions}." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfigOptions", + "text": "RouteConfigOptions" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteConfigOptions", + "type": "Interface", + "tags": [], + "label": "RouteConfigOptions", + "description": [ + "\nAdditional route options." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfigOptions", + "text": "RouteConfigOptions" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteConfigOptions.authRequired", + "type": "CompoundType", + "tags": [], + "label": "authRequired", + "description": [ + "\nDefines authentication mode for a route:\n- true. A user has to have valid credentials to access a resource\n- false. A user can access a resource without any credentials.\n- 'optional'. A user can access a resource, and will be authenticated if provided credentials are valid.\n Can be useful when we grant access to a resource but want to identify a user if possible.\n\nDefaults to `true` if an auth mechanism is registered." + ], + "signature": [ + "boolean | \"optional\" | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteConfigOptions.xsrfRequired", + "type": "Uncategorized", + "tags": [], + "label": "xsrfRequired", + "description": [ + "\nDefines xsrf protection requirements for a route:\n- true. Requires an incoming POST/PUT/DELETE request to contain `kbn-xsrf` header.\n- false. Disables xsrf protection.\n\nSet to true by default" + ], + "signature": [ + "(Method extends \"get\" ? never : boolean) | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteConfigOptions.tags", + "type": "Object", + "tags": [], + "label": "tags", + "description": [ + "\nAdditional metadata tag strings to attach to the route." + ], + "signature": [ + "readonly string[] | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteConfigOptions.body", + "type": "Uncategorized", + "tags": [], + "label": "body", + "description": [ + "\nAdditional body options {@link RouteConfigOptionsBody}." + ], + "signature": [ + "(Method extends \"options\" | \"get\" ? undefined : ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfigOptionsBody", + "text": "RouteConfigOptionsBody" + }, + ") | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteConfigOptions.timeout", + "type": "Object", + "tags": [], + "label": "timeout", + "description": [ + "\nDefines per-route timeouts." + ], + "signature": [ + "{ payload?: (Method extends \"options\" | \"get\" ? undefined : number) | undefined; idleSocket?: number | undefined; } | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteConfigOptionsBody", + "type": "Interface", + "tags": [], + "label": "RouteConfigOptionsBody", + "description": [ + "\nAdditional body options for a route" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteConfigOptionsBody.accepts", + "type": "CompoundType", + "tags": [], + "label": "accepts", + "description": [ + "\nA string or an array of strings with the allowed mime types for the endpoint. Use this settings to limit the set of allowed mime types. Note that allowing additional mime types not listed\nabove will not enable them to be parsed, and if parse is true, the request will result in an error response.\n\nDefault value: allows parsing of the following mime types:\n* application/json\n* application/*+json\n* application/octet-stream\n* application/x-www-form-urlencoded\n* multipart/form-data\n* text/*" + ], + "signature": [ + "string | string[] | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteContentType", + "text": "RouteContentType" + }, + "[] | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteConfigOptionsBody.maxBytes", + "type": "number", + "tags": [], + "label": "maxBytes", + "description": [ + "\nLimits the size of incoming payloads to the specified byte count. Allowing very large payloads may cause the server to run out of memory.\n\nDefault value: The one set in the kibana.yml config file under the parameter `server.maxPayload`." + ], + "signature": [ + "number | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteConfigOptionsBody.output", + "type": "CompoundType", + "tags": [], + "label": "output", + "description": [ + "\nThe processed payload format. The value must be one of:\n* 'data' - the incoming payload is read fully into memory. If parse is true, the payload is parsed (JSON, form-decoded, multipart) based on the 'Content-Type' header. If parse is false, a raw\nBuffer is returned.\n* 'stream' - the incoming payload is made available via a Stream.Readable interface. If the payload is 'multipart/form-data' and parse is true, field values are presented as text while files\nare provided as streams. File streams from a 'multipart/form-data' upload will also have a hapi property containing the filename and headers properties. Note that payload streams for multipart\npayloads are a synthetic interface created on top of the entire multipart content loaded into memory. To avoid loading large multipart payloads into memory, set parse to false and handle the\nmultipart payload in the handler using a streaming parser (e.g. pez).\n\nDefault value: 'data', unless no validation.body is provided in the route definition. In that case the default is 'stream' to alleviate memory pressure." + ], + "signature": [ + "\"data\" | \"stream\" | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteConfigOptionsBody.parse", + "type": "CompoundType", + "tags": [], + "label": "parse", + "description": [ + "\nDetermines if the incoming payload is processed or presented raw. Available values:\n* true - if the request 'Content-Type' matches the allowed mime types set by allow (for the whole payload as well as parts), the payload is converted into an object when possible. If the\nformat is unknown, a Bad Request (400) error response is sent. Any known content encoding is decoded.\n* false - the raw payload is returned unmodified.\n* 'gunzip' - the raw payload is returned unmodified after any known content encoding is decoded.\n\nDefault value: true, unless no validation.body is provided in the route definition. In that case the default is false to alleviate memory pressure." + ], + "signature": [ + "boolean | \"gunzip\" | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouterRoute", + "type": "Interface", + "tags": [], + "label": "RouterRoute", + "description": [], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouterRoute.method", + "type": "CompoundType", + "tags": [], + "label": "method", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.SafeRouteMethod", + "text": "SafeRouteMethod" + }, + " | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.DestructiveRouteMethod", + "text": "DestructiveRouteMethod" + } + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouterRoute.path", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouterRoute.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfigOptions", + "text": "RouteConfigOptions" + }, + "<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteMethod", + "text": "RouteMethod" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouterRoute.handler", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ + "(req: ", + "Request", + ", responseToolkit: ", + "ResponseToolkit", + ") => Promise<", + "Boom", + " | ", + "ResponseObject", + ">" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouterRoute.handler.$1", + "type": "Object", + "tags": [], + "label": "req", + "description": [], + "signature": [ + "Request" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouterRoute.handler.$2", + "type": "Object", + "tags": [], + "label": "responseToolkit", + "description": [], + "signature": [ + "ResponseToolkit" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidationResultFactory", + "type": "Interface", + "tags": [], + "label": "RouteValidationResultFactory", + "description": [ + "\nValidation result factory to be used in the custom validation function to return the valid data or validation errors\n\nSee {@link RouteValidationFunction}.\n" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidationResultFactory.ok", + "type": "Function", + "tags": [], + "label": "ok", + "description": [], + "signature": [ + "(value: T) => { value: T; }" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidationResultFactory.ok.$1", + "type": "Uncategorized", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "T" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidationResultFactory.badRequest", + "type": "Function", + "tags": [], + "label": "badRequest", + "description": [], + "signature": [ + "(error: string | Error, path?: string[] | undefined) => { error: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteValidationError", + "text": "RouteValidationError" + }, + "; }" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidationResultFactory.badRequest.$1", + "type": "CompoundType", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "string | Error" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidationResultFactory.badRequest.$2", + "type": "Array", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidatorConfig", + "type": "Interface", + "tags": [], + "label": "RouteValidatorConfig", + "description": [ + "\nThe configuration object to the RouteValidator class.\nSet `params`, `query` and/or `body` to specify the validation logic to follow for that property.\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteValidatorConfig", + "text": "RouteValidatorConfig" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidatorConfig.params", + "type": "CompoundType", + "tags": [], + "label": "params", + "description": [ + "\nValidation logic for the URL params" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteValidationSpec", + "text": "RouteValidationSpec" + }, + "

| undefined" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidatorConfig.query", + "type": "CompoundType", + "tags": [], + "label": "query", + "description": [ + "\nValidation logic for the Query params" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteValidationSpec", + "text": "RouteValidationSpec" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidatorConfig.body", + "type": "CompoundType", + "tags": [], + "label": "body", + "description": [ + "\nValidation logic for the body payload" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteValidationSpec", + "text": "RouteValidationSpec" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidatorOptions", + "type": "Interface", + "tags": [], + "label": "RouteValidatorOptions", + "description": [ + "\nAdditional options for the RouteValidator class to modify its default behaviour.\n" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidatorOptions.unsafe", + "type": "Object", + "tags": [], + "label": "unsafe", + "description": [ + "\nSet the `unsafe` config to avoid running some additional internal *safe* validations on top of your custom validation" + ], + "signature": [ + "{ params?: boolean | undefined; query?: boolean | undefined; body?: boolean | undefined; } | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionCookieValidationResult", + "type": "Interface", + "tags": [], + "label": "SessionCookieValidationResult", + "description": [ + "\nReturn type from a function to validate cookie contents." + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionCookieValidationResult.isValid", + "type": "boolean", + "tags": [], + "label": "isValid", + "description": [ + "\nWhether the cookie is valid or not." + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionCookieValidationResult.path", + "type": "string", + "tags": [], + "label": "path", + "description": [ + "\nThe \"Path\" attribute of the cookie; if the cookie is invalid, this is used to clear it." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionStorage", + "type": "Interface", + "tags": [], + "label": "SessionStorage", + "description": [ + "\nProvides an interface to store and retrieve data across requests." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.SessionStorage", + "text": "SessionStorage" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionStorage.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [ + "\nRetrieves session value from the session storage." + ], + "signature": [ + "() => Promise" + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionStorage.set", + "type": "Function", + "tags": [], + "label": "set", + "description": [ + "\nPuts current session value into the session storage." + ], + "signature": [ + "(sessionValue: T) => void" + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionStorage.set.$1", + "type": "Uncategorized", + "tags": [], + "label": "sessionValue", + "description": [ + "- value to put" + ], + "signature": [ + "T" + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionStorage.clear", + "type": "Function", + "tags": [], + "label": "clear", + "description": [ + "\nClears current session." + ], + "signature": [ + "() => void" + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionStorageCookieOptions", + "type": "Interface", + "tags": [], + "label": "SessionStorageCookieOptions", + "description": [ + "\nConfiguration used to create HTTP session storage based on top of cookie mechanism." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.SessionStorageCookieOptions", + "text": "SessionStorageCookieOptions" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionStorageCookieOptions.name", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "\nName of the session cookie." + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionStorageCookieOptions.encryptionKey", + "type": "string", + "tags": [], + "label": "encryptionKey", + "description": [ + "\nA key used to encrypt a cookie's value. Should be at least 32 characters long." + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionStorageCookieOptions.validate", + "type": "Function", + "tags": [], + "label": "validate", + "description": [ + "\nFunction called to validate a cookie's decrypted value." + ], + "signature": [ + "(sessionValue: T | T[]) => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.SessionCookieValidationResult", + "text": "SessionCookieValidationResult" + } + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionStorageCookieOptions.validate.$1", + "type": "CompoundType", + "tags": [], + "label": "sessionValue", + "description": [], + "signature": [ + "T | T[]" + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionStorageCookieOptions.isSecure", + "type": "boolean", + "tags": [], + "label": "isSecure", + "description": [ + "\nFlag indicating whether the cookie should be sent only via a secure connection." + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionStorageCookieOptions.sameSite", + "type": "CompoundType", + "tags": [], + "label": "sameSite", + "description": [ + "\nDefines SameSite attribute of the Set-Cookie Header.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite" + ], + "signature": [ + "\"None\" | \"Strict\" | \"Lax\" | undefined" + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionStorageFactory", + "type": "Interface", + "tags": [], + "label": "SessionStorageFactory", + "description": [ + "\nSessionStorage factory to bind one to an incoming request" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.SessionStorageFactory", + "text": "SessionStorageFactory" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionStorageFactory.asScoped", + "type": "Function", + "tags": [], + "label": "asScoped", + "description": [], + "signature": [ + "(request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.SessionStorage", + "text": "SessionStorage" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionStorageFactory.asScoped.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "enums": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthResultType", + "type": "Enum", + "tags": [], + "label": "AuthResultType", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthStatus", + "type": "Enum", + "tags": [], + "label": "AuthStatus", + "description": [ + "\nStatus indicating an outcome of the authentication." + ], + "path": "packages/core/http/core-http-server/src/auth_state.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseResultType", + "type": "Enum", + "tags": [], + "label": "OnPreResponseResultType", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreRoutingResultType", + "type": "Enum", + "tags": [], + "label": "OnPreRoutingResultType", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_routing.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "misc": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthenticationHandler", + "type": "Type", + "tags": [], + "label": "AuthenticationHandler", + "description": [ + "\nSee {@link AuthToolkit}." + ], + "signature": [ + "(request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.LifecycleResponseFactory", + "text": "LifecycleResponseFactory" + }, + ", toolkit: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthToolkit", + "text": "AuthToolkit" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthResult", + "text": "AuthResult" + }, + " | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | Promise<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthResult", + "text": "AuthResult" + }, + " | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthenticationHandler.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthenticationHandler.$2", + "type": "CompoundType", + "tags": [], + "label": "response", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRedirectionResponseFactory", + "text": "KibanaRedirectionResponseFactory" + }, + " & ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaErrorResponseFactory", + "text": "KibanaErrorResponseFactory" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthenticationHandler.$3", + "type": "Object", + "tags": [], + "label": "toolkit", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthToolkit", + "text": "AuthToolkit" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthHeaders", + "type": "Type", + "tags": [], + "label": "AuthHeaders", + "description": [], + "signature": [ + "{ [x: string]: string | string[]; }" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthResult", + "type": "Type", + "tags": [], + "label": "AuthResult", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthResultAuthenticated", + "text": "AuthResultAuthenticated" + }, + " | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthResultNotHandled", + "text": "AuthResultNotHandled" + }, + " | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthResultRedirected", + "text": "AuthResultRedirected" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.DestructiveRouteMethod", + "type": "Type", + "tags": [], + "label": "DestructiveRouteMethod", + "description": [ + "\nSet of HTTP methods changing the state of the server." + ], + "signature": [ + "\"delete\" | \"post\" | \"put\" | \"patch\"" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.GetAuthHeaders", + "type": "Type", + "tags": [ + "return" + ], + "label": "GetAuthHeaders", + "description": [ + "\nGet headers to authenticate a user against Elasticsearch." + ], + "signature": [ + "(request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthHeaders", + "text": "AuthHeaders" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/auth_headers.ts", + "deprecated": false, + "returnComment": [ + "authentication headers {@link AuthHeaders } for - an incoming request." + ], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.GetAuthHeaders.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [ + "{@link KibanaRequest } - an incoming request." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/auth_headers.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.GetAuthState", + "type": "Type", + "tags": [], + "label": "GetAuthState", + "description": [ + "\nGets authentication state for a request. Returned by `auth` interceptor." + ], + "signature": [ + "(request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => { status: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthStatus", + "text": "AuthStatus" + }, + "; state: T; }" + ], + "path": "packages/core/http/core-http-server/src/auth_state.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.GetAuthState.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [ + "{@link KibanaRequest } - an incoming request." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/auth_state.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HandlerContextType", + "type": "Type", + "tags": [], + "label": "HandlerContextType", + "description": [ + "\nExtracts the type of the first argument of a {@link HandlerFunction} to represent the type of the context.\n" + ], + "signature": [ + "T extends ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.HandlerFunction", + "text": "HandlerFunction" + }, + " ? U : never" + ], + "path": "packages/core/http/core-http-server/src/router/context_provider.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HandlerFunction", + "type": "Type", + "tags": [], + "label": "HandlerFunction", + "description": [ + "\nA function that accepts a context object and an optional number of additional arguments. Used for the generic types\nin {@link IContextContainer}\n" + ], + "signature": [ + "(context: T, ...args: any[]) => any" + ], + "path": "packages/core/http/core-http-server/src/router/context_provider.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HandlerFunction.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "T" + ], + "path": "packages/core/http/core-http-server/src/router/context_provider.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HandlerFunction.$2", + "type": "Array", + "tags": [], + "label": "args", + "description": [], + "signature": [ + "any[]" + ], + "path": "packages/core/http/core-http-server/src/router/context_provider.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HandlerParameters", + "type": "Type", + "tags": [], + "label": "HandlerParameters", + "description": [ + "\nExtracts the types of the additional arguments of a {@link HandlerFunction}, excluding the\n{@link HandlerContextType}.\n" + ], + "signature": [ + "T extends (context: any, ...args: infer U) => any ? U : never" + ], + "path": "packages/core/http/core-http-server/src/router/context_provider.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.Headers", + "type": "Type", + "tags": [], + "label": "Headers", + "description": [ + "\nHttp request headers to read." + ], + "signature": [ + "{ warning?: string | string[] | undefined; from?: string | string[] | undefined; date?: string | string[] | undefined; expires?: string | string[] | undefined; range?: string | string[] | undefined; origin?: string | string[] | undefined; location?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; etag?: string | string[] | undefined; authorization?: string | string[] | undefined; connection?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" + ], + "path": "packages/core/http/core-http-server/src/router/headers.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpResponsePayload", + "type": "Type", + "tags": [], + "label": "HttpResponsePayload", + "description": [ + "\nData send to the client as a response payload." + ], + "signature": [ + "string | Record | ", + "Stream", + " | Buffer | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IContextProvider", + "type": "Type", + "tags": [], + "label": "IContextProvider", + "description": [ + "\nA function that returns a context value for a specific key of given context type.\n" + ], + "signature": [ + "(context: Omit, request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaResponseFactory", + "text": "KibanaResponseFactory" + }, + ") => ", + "MaybePromise", + ">" + ], + "path": "packages/core/http/core-http-server/src/router/context_provider.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": "@kbn/core-http-server", + "id": "def-server.IContextProvider.$1", + "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": "packages/core/http/core-http-server/src/router/context_provider.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IContextProvider.$2", + "type": "Object", + "tags": [], + "label": "rest", + "description": [ + "- Additional parameters provided by the service owner of this context" + ], + "signature": [ + "[request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaResponseFactory", + "text": "KibanaResponseFactory" + }, + "]" + ], + "path": "packages/core/http/core-http-server/src/router/context_provider.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IsAuthenticated", + "type": "Type", + "tags": [], + "label": "IsAuthenticated", + "description": [ + "\nReturns authentication status for a request." + ], + "signature": [ + "(request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => boolean" + ], + "path": "packages/core/http/core-http-server/src/auth_state.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IsAuthenticated.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [ + "{@link KibanaRequest } - an incoming request." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/auth_state.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequestRouteOptions", + "type": "Type", + "tags": [], + "label": "KibanaRequestRouteOptions", + "description": [ + "\nRoute options: If 'GET' or 'OPTIONS' method, body options won't be returned." + ], + "signature": [ + "Method extends \"options\" | \"get\" ? Required, \"body\">> : Required<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfigOptions", + "text": "RouteConfigOptions" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaResponseFactory", + "type": "Type", + "tags": [], + "label": "KibanaResponseFactory", + "description": [ + "\nSet of helpers used to create `KibanaResponse` to form HTTP response on an incoming request.\nShould be returned as a result of {@link RequestHandler} execution.\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaSuccessResponseFactory", + "text": "KibanaSuccessResponseFactory" + }, + " & ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRedirectionResponseFactory", + "text": "KibanaRedirectionResponseFactory" + }, + " & ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaErrorResponseFactory", + "text": "KibanaErrorResponseFactory" + }, + " & { custom | Error | ", + "Stream", + " | Buffer | { message: string | Error; attributes?: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ResponseErrorAttributes", + "text": "ResponseErrorAttributes" + }, + " | undefined; } | undefined>(options: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "): ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + "; }" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KnownHeaders", + "type": "Type", + "tags": [], + "label": "KnownHeaders", + "description": [ + "\nSet of well-known HTTP headers." + ], + "signature": [ + "\"warning\" | \"from\" | \"date\" | \"expires\" | \"range\" | \"origin\" | \"location\" | \"allow\" | \"accept\" | \"host\" | \"etag\" | \"authorization\" | \"connection\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"cache-control\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"expect\" | \"forwarded\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\"" + ], + "path": "packages/core/http/core-http-server/src/router/headers.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KnownKeys", + "type": "Type", + "tags": [], + "label": "KnownKeys", + "description": [ + "\nCreates a Union type of all known keys of a given interface." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.StringKeysAsVals", + "text": "StringKeysAsVals" + }, + " extends { [_ in keyof T]: infer U; } ? U : never" + ], + "path": "packages/core/http/core-http-server/src/router/headers.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.LifecycleResponseFactory", + "type": "Type", + "tags": [], + "label": "LifecycleResponseFactory", + "description": [ + "\nCreates an object containing redirection or error response with error details, HTTP headers, and other data transmitted to the client." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRedirectionResponseFactory", + "text": "KibanaRedirectionResponseFactory" + }, + " & ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaErrorResponseFactory", + "text": "KibanaErrorResponseFactory" + } + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPostAuthHandler", + "type": "Type", + "tags": [], + "label": "OnPostAuthHandler", + "description": [ + "\nSee {@link OnPostAuthToolkit}." + ], + "signature": [ + "(request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.LifecycleResponseFactory", + "text": "LifecycleResponseFactory" + }, + ", toolkit: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPostAuthToolkit", + "text": "OnPostAuthToolkit" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPostAuthNextResult", + "text": "OnPostAuthNextResult" + }, + " | Promise<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPostAuthNextResult", + "text": "OnPostAuthNextResult" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_post_auth.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPostAuthHandler.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_post_auth.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPostAuthHandler.$2", + "type": "CompoundType", + "tags": [], + "label": "response", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRedirectionResponseFactory", + "text": "KibanaRedirectionResponseFactory" + }, + " & ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaErrorResponseFactory", + "text": "KibanaErrorResponseFactory" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_post_auth.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPostAuthHandler.$3", + "type": "Object", + "tags": [], + "label": "toolkit", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPostAuthToolkit", + "text": "OnPostAuthToolkit" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_post_auth.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPostAuthResult", + "type": "Type", + "tags": [], + "label": "OnPostAuthResult", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPostAuthNextResult", + "text": "OnPostAuthNextResult" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_post_auth.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPostAuthResultType", + "type": "string", + "tags": [], + "label": "OnPostAuthResultType", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/on_post_auth.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreAuthHandler", + "type": "Type", + "tags": [], + "label": "OnPreAuthHandler", + "description": [ + "\nSee {@link OnPreAuthToolkit}." + ], + "signature": [ + "(request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.LifecycleResponseFactory", + "text": "LifecycleResponseFactory" + }, + ", toolkit: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreAuthToolkit", + "text": "OnPreAuthToolkit" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreAuthNextResult", + "text": "OnPreAuthNextResult" + }, + " | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | Promise<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreAuthNextResult", + "text": "OnPreAuthNextResult" + }, + " | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_auth.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreAuthHandler.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_auth.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreAuthHandler.$2", + "type": "CompoundType", + "tags": [], + "label": "response", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRedirectionResponseFactory", + "text": "KibanaRedirectionResponseFactory" + }, + " & ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaErrorResponseFactory", + "text": "KibanaErrorResponseFactory" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_auth.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreAuthHandler.$3", + "type": "Object", + "tags": [], + "label": "toolkit", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreAuthToolkit", + "text": "OnPreAuthToolkit" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_auth.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreAuthResult", + "type": "Type", + "tags": [], + "label": "OnPreAuthResult", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreAuthNextResult", + "text": "OnPreAuthNextResult" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_auth.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreAuthResultType", + "type": "string", + "tags": [], + "label": "OnPreAuthResultType", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_auth.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseHandler", + "type": "Type", + "tags": [], + "label": "OnPreResponseHandler", + "description": [ + "\nSee {@link OnPreResponseToolkit}." + ], + "signature": [ + "(request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", preResponse: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseInfo", + "text": "OnPreResponseInfo" + }, + ", toolkit: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseToolkit", + "text": "OnPreResponseToolkit" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseResult", + "text": "OnPreResponseResult" + }, + " | Promise<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseResult", + "text": "OnPreResponseResult" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseHandler.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseHandler.$2", + "type": "Object", + "tags": [], + "label": "preResponse", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseInfo", + "text": "OnPreResponseInfo" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseHandler.$3", + "type": "Object", + "tags": [], + "label": "toolkit", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseToolkit", + "text": "OnPreResponseToolkit" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseResult", + "type": "Type", + "tags": [], + "label": "OnPreResponseResult", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseResultRender", + "text": "OnPreResponseResultRender" + }, + " | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseResultNext", + "text": "OnPreResponseResultNext" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreRoutingHandler", + "type": "Type", + "tags": [], + "label": "OnPreRoutingHandler", + "description": [ + "\nSee {@link OnPreRoutingToolkit}." + ], + "signature": [ + "(request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.LifecycleResponseFactory", + "text": "LifecycleResponseFactory" + }, + ", toolkit: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreRoutingToolkit", + "text": "OnPreRoutingToolkit" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreRoutingResult", + "text": "OnPreRoutingResult" + }, + " | Promise<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreRoutingResult", + "text": "OnPreRoutingResult" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_routing.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreRoutingHandler.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_routing.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreRoutingHandler.$2", + "type": "CompoundType", + "tags": [], + "label": "response", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRedirectionResponseFactory", + "text": "KibanaRedirectionResponseFactory" + }, + " & ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaErrorResponseFactory", + "text": "KibanaErrorResponseFactory" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_routing.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreRoutingHandler.$3", + "type": "Object", + "tags": [], + "label": "toolkit", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreRoutingToolkit", + "text": "OnPreRoutingToolkit" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_routing.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreRoutingResult", + "type": "Type", + "tags": [], + "label": "OnPreRoutingResult", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreRoutingResultNext", + "text": "OnPreRoutingResultNext" + }, + " | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreRoutingResultRewriteUrl", + "text": "OnPreRoutingResultRewriteUrl" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_routing.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RedirectResponseOptions", + "type": "Type", + "tags": [], + "label": "RedirectResponseOptions", + "description": [ + "\nHTTP response parameters for redirection response" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + " & { headers: { location: string; }; }" + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RequestHandler", + "type": "Type", + "tags": [], + "label": "RequestHandler", + "description": [ + "\nA function executed when route path matched requested resource path.\nRequest handler is expected to return a result of one of {@link KibanaResponseFactory} functions.\nIf anything else is returned, or an error is thrown, the HTTP service will automatically log the error\nand respond `500 - Internal Server Error`." + ], + "signature": [ + "(context: Context, request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ResponseFactory) => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | Promise<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RequestHandler.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [ + "{@link RequestHandlerContext } - the core context exposed for this request." + ], + "signature": [ + "Context" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RequestHandler.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [ + "{@link KibanaRequest } - object containing information about requested resource,\nsuch as path, method, headers, parameters, query, body, etc." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RequestHandler.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [ + "{@link KibanaResponseFactory } - a set of helper functions used to respond to a request." + ], + "signature": [ + "ResponseFactory" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RequestHandlerWrapper", + "type": "Type", + "tags": [], + "label": "RequestHandlerWrapper", + "description": [ + "\nType-safe wrapper for {@link RequestHandler} function." + ], + "signature": [ + "(handler: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RequestHandlerWrapper.$1", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ + "(context: Context, request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ResponseFactory) => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | Promise<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RequestHandlerWrapper.$1.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RequestHandlerWrapper.$1.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RequestHandlerWrapper.$1.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.ResponseError", + "type": "Type", + "tags": [], + "label": "ResponseError", + "description": [ + "\nError message and optional data send to the client in case of error." + ], + "signature": [ + "string | Error | { message: string | Error; attributes?: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ResponseErrorAttributes", + "text": "ResponseErrorAttributes" + }, + " | undefined; }" + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.ResponseErrorAttributes", + "type": "Type", + "tags": [], + "label": "ResponseErrorAttributes", + "description": [ + "\nAdditional data to provide error details." + ], + "signature": [ + "{ [x: string]: any; }" + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.ResponseHeaders", + "type": "Type", + "tags": [], + "label": "ResponseHeaders", + "description": [ + "\nHttp response headers to set." + ], + "signature": [ + "Record<\"warning\" | \"from\" | \"date\" | \"expires\" | \"range\" | \"origin\" | \"location\" | \"allow\" | \"accept\" | \"host\" | \"etag\" | \"authorization\" | \"connection\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"cache-control\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"expect\" | \"forwarded\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]> | Record" + ], + "path": "packages/core/http/core-http-server/src/router/headers.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteContentType", + "type": "Type", + "tags": [], + "label": "RouteContentType", + "description": [ + "\nThe set of supported parseable Content-Types" + ], + "signature": [ + "\"application/json\" | \"multipart/form-data\" | \"application/*+json\" | \"application/octet-stream\" | \"application/x-www-form-urlencoded\" | \"text/*\"" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteMethod", + "type": "Type", + "tags": [], + "label": "RouteMethod", + "description": [ + "\nThe set of common HTTP methods supported by Kibana routing." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.SafeRouteMethod", + "text": "SafeRouteMethod" + }, + " | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.DestructiveRouteMethod", + "text": "DestructiveRouteMethod" + } + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteRegistrar", + "type": "Type", + "tags": [], + "label": "RouteRegistrar", + "description": [ + "\nRoute handler common definition\n" + ], + "signature": [ + "(route: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + ", handler: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + ") => void" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteRegistrar.$1", + "type": "Object", + "tags": [], + "label": "route", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteRegistrar.$2", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ + "(context: Context, request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaResponseFactory", + "text": "KibanaResponseFactory" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | Promise<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteRegistrar.$2.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteRegistrar.$2.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteRegistrar.$2.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidationFunction", + "type": "Type", + "tags": [], + "label": "RouteValidationFunction", + "description": [ + "\nThe custom validation function if @kbn/config-schema is not a valid solution for your specific plugin requirements.\n" + ], + "signature": [ + "(data: any, validationResult: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteValidationResultFactory", + "text": "RouteValidationResultFactory" + }, + ") => { value: T; error?: undefined; } | { value?: undefined; error: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteValidationError", + "text": "RouteValidationError" + }, + "; }" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidationFunction.$1", + "type": "Any", + "tags": [], + "label": "data", + "description": [], + "signature": [ + "any" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidationFunction.$2", + "type": "Object", + "tags": [], + "label": "validationResult", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteValidationResultFactory", + "text": "RouteValidationResultFactory" + } + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidationSpec", + "type": "Type", + "tags": [], + "label": "RouteValidationSpec", + "description": [ + "\nAllowed property validation options: either @kbn/config-schema validations or custom validation functions\n\nSee {@link RouteValidationFunction} for custom validation.\n" + ], + "signature": [ + "ObjectType", + " | ", + "Type", + " | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteValidationFunction", + "text": "RouteValidationFunction" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidatorFullConfig", + "type": "Type", + "tags": [], + "label": "RouteValidatorFullConfig", + "description": [ + "\nRoute validations config and options merged into one object" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteValidatorConfig", + "text": "RouteValidatorConfig" + }, + " & ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteValidatorOptions", + "text": "RouteValidatorOptions" + } + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SafeRouteMethod", + "type": "Type", + "tags": [], + "label": "SafeRouteMethod", + "description": [ + "\nSet of HTTP methods not changing the state of the server." + ], + "signature": [ + "\"options\" | \"get\"" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SetAuthHeaders", + "type": "Type", + "tags": [], + "label": "SetAuthHeaders", + "description": [], + "signature": [ + "(request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", headers: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthHeaders", + "text": "AuthHeaders" + }, + ") => void" + ], + "path": "packages/core/http/core-http-server/src/auth_headers.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SetAuthHeaders.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/auth_headers.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SetAuthHeaders.$2", + "type": "Object", + "tags": [], + "label": "headers", + "description": [], + "signature": [ + "{ [x: string]: string | string[]; }" + ], + "path": "packages/core/http/core-http-server/src/auth_headers.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.StringKeysAsVals", + "type": "Type", + "tags": [], + "label": "StringKeysAsVals", + "description": [ + "\nConverts an object type to a new object type where each string\nkey is copied to the values of the object, and non string keys are\ngiven a `never` value. This allows us to map over the values and\nget the list of all string keys on a type in `KnownKeys`\n" + ], + "signature": [ + "{ [K in keyof T]: string extends K ? never : number extends K ? never : K; }" + ], + "path": "packages/core/http/core-http-server/src/router/headers.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.validBodyOutput", + "type": "Object", + "tags": [], + "label": "validBodyOutput", + "description": [ + "\nThe set of valid body.output" + ], + "signature": [ + "readonly [\"data\", \"stream\"]" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false, + "initialIsOpen": false + } + ] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_http_server.mdx b/api_docs/kbn_core_http_server.mdx new file mode 100644 index 0000000000000..80871a81a9d25 --- /dev/null +++ b/api_docs/kbn_core_http_server.mdx @@ -0,0 +1,39 @@ +--- +id: kibKbnCoreHttpServerPluginApi +slug: /kibana-dev-docs/api/kbn-core-http-server +title: "@kbn/core-http-server" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-http-server plugin +date: 2022-07-13 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-server'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnCoreHttpServerObj from './kbn_core_http_server.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 392 | 1 | 154 | 0 | + +## Server + +### Objects + + +### Classes + + +### Interfaces + + +### Enums + + +### Consts, variables and types + + diff --git a/api_docs/kbn_core_i18n_browser.mdx b/api_docs/kbn_core_i18n_browser.mdx index a96c9c6bd2c8f..fd5dc5578ec45 100644 --- a/api_docs/kbn_core_i18n_browser.mdx +++ b/api_docs/kbn_core_i18n_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-i18n-browser title: "@kbn/core-i18n-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-i18n-browser plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-i18n-browser'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_i18n_browser_mocks.mdx b/api_docs/kbn_core_i18n_browser_mocks.mdx index 2f854b467db8b..451a717d03e00 100644 --- a/api_docs/kbn_core_i18n_browser_mocks.mdx +++ b/api_docs/kbn_core_i18n_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-i18n-browser-mocks title: "@kbn/core-i18n-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-i18n-browser-mocks plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-i18n-browser-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_injected_metadata_browser.mdx b/api_docs/kbn_core_injected_metadata_browser.mdx index f9b955bf74d1b..e1277bff51595 100644 --- a/api_docs/kbn_core_injected_metadata_browser.mdx +++ b/api_docs/kbn_core_injected_metadata_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-injected-metadata-browser title: "@kbn/core-injected-metadata-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-injected-metadata-browser plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-injected-metadata-browser'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_injected_metadata_browser_mocks.mdx b/api_docs/kbn_core_injected_metadata_browser_mocks.mdx index 6e45d37b61d00..315b6ccb8dd93 100644 --- a/api_docs/kbn_core_injected_metadata_browser_mocks.mdx +++ b/api_docs/kbn_core_injected_metadata_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-injected-metadata-browser-mocks title: "@kbn/core-injected-metadata-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-injected-metadata-browser-mocks plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-injected-metadata-browser-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_logging_server.mdx b/api_docs/kbn_core_logging_server.mdx index b784feda2e314..1e2f604a6658a 100644 --- a/api_docs/kbn_core_logging_server.mdx +++ b/api_docs/kbn_core_logging_server.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-server title: "@kbn/core-logging-server" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-logging-server plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-server'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_logging_server_internal.mdx b/api_docs/kbn_core_logging_server_internal.mdx index f221b342cbc73..6c2e940096f8a 100644 --- a/api_docs/kbn_core_logging_server_internal.mdx +++ b/api_docs/kbn_core_logging_server_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-server-internal title: "@kbn/core-logging-server-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-logging-server-internal plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-server-internal'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_logging_server_mocks.mdx b/api_docs/kbn_core_logging_server_mocks.mdx index 4a6aa7dd3931f..41a4a645ccbb6 100644 --- a/api_docs/kbn_core_logging_server_mocks.mdx +++ b/api_docs/kbn_core_logging_server_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-server-mocks title: "@kbn/core-logging-server-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-logging-server-mocks plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-server-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_node_server.mdx b/api_docs/kbn_core_node_server.mdx index cffa601f3848a..1b2f3c80de467 100644 --- a/api_docs/kbn_core_node_server.mdx +++ b/api_docs/kbn_core_node_server.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-node-server title: "@kbn/core-node-server" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-node-server plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-node-server'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_node_server_internal.mdx b/api_docs/kbn_core_node_server_internal.mdx index 34369234aaaef..5885b29b2c8c8 100644 --- a/api_docs/kbn_core_node_server_internal.mdx +++ b/api_docs/kbn_core_node_server_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-node-server-internal title: "@kbn/core-node-server-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-node-server-internal plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-node-server-internal'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_node_server_mocks.mdx b/api_docs/kbn_core_node_server_mocks.mdx index c957b4655d511..9e667be321173 100644 --- a/api_docs/kbn_core_node_server_mocks.mdx +++ b/api_docs/kbn_core_node_server_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-node-server-mocks title: "@kbn/core-node-server-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-node-server-mocks plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-node-server-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_preboot_server.devdocs.json b/api_docs/kbn_core_preboot_server.devdocs.json new file mode 100644 index 0000000000000..554377c1e0c71 --- /dev/null +++ b/api_docs/kbn_core_preboot_server.devdocs.json @@ -0,0 +1,110 @@ +{ + "id": "@kbn/core-preboot-server", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [ + { + "parentPluginId": "@kbn/core-preboot-server", + "id": "def-server.PrebootServicePreboot", + "type": "Interface", + "tags": [], + "label": "PrebootServicePreboot", + "description": [ + "\nKibana Preboot Service allows to control the boot flow of Kibana. Preboot plugins can use it to hold the boot until certain condition is met.\n" + ], + "path": "packages/core/preboot/core-preboot-server/src/contracts.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-preboot-server", + "id": "def-server.PrebootServicePreboot.isSetupOnHold", + "type": "Function", + "tags": [], + "label": "isSetupOnHold", + "description": [ + "\nIndicates whether Kibana is currently on hold and cannot proceed to `setup` yet." + ], + "signature": [ + "() => boolean" + ], + "path": "packages/core/preboot/core-preboot-server/src/contracts.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-preboot-server", + "id": "def-server.PrebootServicePreboot.holdSetupUntilResolved", + "type": "Function", + "tags": [], + "label": "holdSetupUntilResolved", + "description": [ + "\nRegisters a `Promise` as a precondition before Kibana can proceed to `setup`. This method can be invoked multiple\ntimes and from multiple `preboot` plugins. Kibana will proceed to `setup` only when all registered `Promises`\ninstances are resolved, or it will shut down if any of them is rejected." + ], + "signature": [ + "(reason: string, promise: Promise<{ shouldReloadConfig: boolean; } | undefined>) => void" + ], + "path": "packages/core/preboot/core-preboot-server/src/contracts.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-preboot-server", + "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": "packages/core/preboot/core-preboot-server/src/contracts.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-preboot-server", + "id": "def-server.PrebootServicePreboot.holdSetupUntilResolved.$2", + "type": "Object", + "tags": [], + "label": "promise", + "description": [ + "A `Promise` that should resolved before Kibana can proceed to `setup`." + ], + "signature": [ + "Promise<{ shouldReloadConfig: boolean; } | undefined>" + ], + "path": "packages/core/preboot/core-preboot-server/src/contracts.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_preboot_server.mdx b/api_docs/kbn_core_preboot_server.mdx new file mode 100644 index 0000000000000..b109431d1dbad --- /dev/null +++ b/api_docs/kbn_core_preboot_server.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnCorePrebootServerPluginApi +slug: /kibana-dev-docs/api/kbn-core-preboot-server +title: "@kbn/core-preboot-server" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-preboot-server plugin +date: 2022-07-13 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-preboot-server'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnCorePrebootServerObj from './kbn_core_preboot_server.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 5 | 0 | 0 | 0 | + +## Server + +### Interfaces + + diff --git a/api_docs/kbn_core_preboot_server_mocks.devdocs.json b/api_docs/kbn_core_preboot_server_mocks.devdocs.json new file mode 100644 index 0000000000000..12dd285db88e9 --- /dev/null +++ b/api_docs/kbn_core_preboot_server_mocks.devdocs.json @@ -0,0 +1,131 @@ +{ + "id": "@kbn/core-preboot-server-mocks", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/core-preboot-server-mocks", + "id": "def-server.InternalPrebootServicePrebootMock", + "type": "Type", + "tags": [], + "label": "InternalPrebootServicePrebootMock", + "description": [], + "signature": [ + "{ readonly isSetupOnHold: jest.MockInstance; readonly holdSetupUntilResolved: jest.MockInstance]>; readonly waitUntilCanSetup: jest.MockInstance, []>; } & ", + "InternalPrebootServicePreboot" + ], + "path": "packages/core/preboot/core-preboot-server-mocks/src/preboot_service.mock.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-preboot-server-mocks", + "id": "def-server.PrebootServicePrebootMock", + "type": "Type", + "tags": [], + "label": "PrebootServicePrebootMock", + "description": [], + "signature": [ + "{ readonly isSetupOnHold: jest.MockInstance; readonly holdSetupUntilResolved: jest.MockInstance]>; } & ", + "PrebootServicePreboot" + ], + "path": "packages/core/preboot/core-preboot-server-mocks/src/preboot_service.mock.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [ + { + "parentPluginId": "@kbn/core-preboot-server-mocks", + "id": "def-server.prebootServiceMock", + "type": "Object", + "tags": [], + "label": "prebootServiceMock", + "description": [], + "path": "packages/core/preboot/core-preboot-server-mocks/src/preboot_service.mock.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-preboot-server-mocks", + "id": "def-server.prebootServiceMock.create", + "type": "Function", + "tags": [], + "label": "create", + "description": [], + "signature": [ + "() => jest.Mocked" + ], + "path": "packages/core/preboot/core-preboot-server-mocks/src/preboot_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [] + }, + { + "parentPluginId": "@kbn/core-preboot-server-mocks", + "id": "def-server.prebootServiceMock.createInternalPrebootContract", + "type": "Function", + "tags": [], + "label": "createInternalPrebootContract", + "description": [], + "signature": [ + "() => ", + { + "pluginId": "@kbn/core-preboot-server-mocks", + "scope": "server", + "docId": "kibKbnCorePrebootServerMocksPluginApi", + "section": "def-server.InternalPrebootServicePrebootMock", + "text": "InternalPrebootServicePrebootMock" + } + ], + "path": "packages/core/preboot/core-preboot-server-mocks/src/preboot_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [] + }, + { + "parentPluginId": "@kbn/core-preboot-server-mocks", + "id": "def-server.prebootServiceMock.createPrebootContract", + "type": "Function", + "tags": [], + "label": "createPrebootContract", + "description": [], + "signature": [ + "() => ", + { + "pluginId": "@kbn/core-preboot-server-mocks", + "scope": "server", + "docId": "kibKbnCorePrebootServerMocksPluginApi", + "section": "def-server.PrebootServicePrebootMock", + "text": "PrebootServicePrebootMock" + } + ], + "path": "packages/core/preboot/core-preboot-server-mocks/src/preboot_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [] + } + ], + "initialIsOpen": false + } + ] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_preboot_server_mocks.mdx b/api_docs/kbn_core_preboot_server_mocks.mdx new file mode 100644 index 0000000000000..ed3173fb57216 --- /dev/null +++ b/api_docs/kbn_core_preboot_server_mocks.mdx @@ -0,0 +1,30 @@ +--- +id: kibKbnCorePrebootServerMocksPluginApi +slug: /kibana-dev-docs/api/kbn-core-preboot-server-mocks +title: "@kbn/core-preboot-server-mocks" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-preboot-server-mocks plugin +date: 2022-07-13 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-preboot-server-mocks'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnCorePrebootServerMocksObj from './kbn_core_preboot_server_mocks.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 6 | 0 | 6 | 0 | + +## Server + +### Objects + + +### Consts, variables and types + + diff --git a/api_docs/kbn_core_theme_browser.mdx b/api_docs/kbn_core_theme_browser.mdx index 294d01ce5776b..09957ca3e6854 100644 --- a/api_docs/kbn_core_theme_browser.mdx +++ b/api_docs/kbn_core_theme_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-theme-browser title: "@kbn/core-theme-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-theme-browser plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-theme-browser'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_theme_browser_internal.mdx b/api_docs/kbn_core_theme_browser_internal.mdx index 353dd6c64cf86..c3a60618f7845 100644 --- a/api_docs/kbn_core_theme_browser_internal.mdx +++ b/api_docs/kbn_core_theme_browser_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-theme-browser-internal title: "@kbn/core-theme-browser-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-theme-browser-internal plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-theme-browser-internal'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_theme_browser_mocks.mdx b/api_docs/kbn_core_theme_browser_mocks.mdx index 5fac4ed90ccc1..3a7174fc1b2e3 100644 --- a/api_docs/kbn_core_theme_browser_mocks.mdx +++ b/api_docs/kbn_core_theme_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-theme-browser-mocks title: "@kbn/core-theme-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-theme-browser-mocks plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-theme-browser-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_crypto.mdx b/api_docs/kbn_crypto.mdx index b2d165a4abd88..7c0e6e7648ffa 100644 --- a/api_docs/kbn_crypto.mdx +++ b/api_docs/kbn_crypto.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-crypto title: "@kbn/crypto" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/crypto plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/crypto'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_crypto_browser.devdocs.json b/api_docs/kbn_crypto_browser.devdocs.json new file mode 100644 index 0000000000000..c35710c489d65 --- /dev/null +++ b/api_docs/kbn_crypto_browser.devdocs.json @@ -0,0 +1,182 @@ +{ + "id": "@kbn/crypto-browser", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [ + { + "parentPluginId": "@kbn/crypto-browser", + "id": "def-common.Sha256", + "type": "Class", + "tags": [], + "label": "Sha256", + "description": [], + "path": "packages/kbn-crypto-browser/src/sha256.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/crypto-browser", + "id": "def-common.Sha256.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "packages/kbn-crypto-browser/src/sha256.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/crypto-browser", + "id": "def-common.Sha256.update", + "type": "Function", + "tags": [], + "label": "update", + "description": [], + "signature": [ + "(data: string | Buffer, encoding?: BufferEncoding | undefined) => ", + { + "pluginId": "@kbn/crypto-browser", + "scope": "common", + "docId": "kibKbnCryptoBrowserPluginApi", + "section": "def-common.Sha256", + "text": "Sha256" + } + ], + "path": "packages/kbn-crypto-browser/src/sha256.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/crypto-browser", + "id": "def-common.Sha256.update.$1", + "type": "CompoundType", + "tags": [], + "label": "data", + "description": [], + "signature": [ + "string | Buffer" + ], + "path": "packages/kbn-crypto-browser/src/sha256.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/crypto-browser", + "id": "def-common.Sha256.update.$2", + "type": "CompoundType", + "tags": [], + "label": "encoding", + "description": [], + "signature": [ + "BufferEncoding | undefined" + ], + "path": "packages/kbn-crypto-browser/src/sha256.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/crypto-browser", + "id": "def-common.Sha256.digest", + "type": "Function", + "tags": [], + "label": "digest", + "description": [], + "signature": [ + "(encoding: BufferEncoding) => string" + ], + "path": "packages/kbn-crypto-browser/src/sha256.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/crypto-browser", + "id": "def-common.Sha256.digest.$1", + "type": "CompoundType", + "tags": [], + "label": "encoding", + "description": [], + "signature": [ + "BufferEncoding" + ], + "path": "packages/kbn-crypto-browser/src/sha256.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/crypto-browser", + "id": "def-common.Sha256._update", + "type": "Function", + "tags": [], + "label": "_update", + "description": [], + "signature": [ + "(M: Buffer) => void" + ], + "path": "packages/kbn-crypto-browser/src/sha256.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/crypto-browser", + "id": "def-common.Sha256._update.$1", + "type": "Object", + "tags": [], + "label": "M", + "description": [], + "signature": [ + "Buffer" + ], + "path": "packages/kbn-crypto-browser/src/sha256.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/crypto-browser", + "id": "def-common.Sha256._hash", + "type": "Function", + "tags": [], + "label": "_hash", + "description": [], + "signature": [ + "() => Buffer" + ], + "path": "packages/kbn-crypto-browser/src/sha256.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_crypto_browser.mdx b/api_docs/kbn_crypto_browser.mdx new file mode 100644 index 0000000000000..6017c04753893 --- /dev/null +++ b/api_docs/kbn_crypto_browser.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnCryptoBrowserPluginApi +slug: /kibana-dev-docs/api/kbn-crypto-browser +title: "@kbn/crypto-browser" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/crypto-browser plugin +date: 2022-07-13 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/crypto-browser'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnCryptoBrowserObj from './kbn_crypto_browser.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 10 | 0 | 10 | 0 | + +## Common + +### Classes + + diff --git a/api_docs/kbn_datemath.mdx b/api_docs/kbn_datemath.mdx index dd2087a0bd167..87f44ac0da128 100644 --- a/api_docs/kbn_datemath.mdx +++ b/api_docs/kbn_datemath.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-datemath title: "@kbn/datemath" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/datemath plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/datemath'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_dev_cli_errors.mdx b/api_docs/kbn_dev_cli_errors.mdx index b0e6f0a5d84a8..0889027b5ed49 100644 --- a/api_docs/kbn_dev_cli_errors.mdx +++ b/api_docs/kbn_dev_cli_errors.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-dev-cli-errors title: "@kbn/dev-cli-errors" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/dev-cli-errors plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-cli-errors'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_dev_cli_runner.mdx b/api_docs/kbn_dev_cli_runner.mdx index 9755a142ec3a7..759f8039981f8 100644 --- a/api_docs/kbn_dev_cli_runner.mdx +++ b/api_docs/kbn_dev_cli_runner.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-dev-cli-runner title: "@kbn/dev-cli-runner" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/dev-cli-runner plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-cli-runner'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_dev_proc_runner.mdx b/api_docs/kbn_dev_proc_runner.mdx index 202df9bf78e32..2d5e8095c3ffd 100644 --- a/api_docs/kbn_dev_proc_runner.mdx +++ b/api_docs/kbn_dev_proc_runner.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-dev-proc-runner title: "@kbn/dev-proc-runner" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/dev-proc-runner plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-proc-runner'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_dev_utils.mdx b/api_docs/kbn_dev_utils.mdx index 132908e24062e..2a578260588bf 100644 --- a/api_docs/kbn_dev_utils.mdx +++ b/api_docs/kbn_dev_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-dev-utils title: "@kbn/dev-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/dev-utils plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_doc_links.devdocs.json b/api_docs/kbn_doc_links.devdocs.json index c50316d8d36b3..75ecd04cd953b 100644 --- a/api_docs/kbn_doc_links.devdocs.json +++ b/api_docs/kbn_doc_links.devdocs.json @@ -510,7 +510,7 @@ "label": "securitySolution", "description": [], "signature": [ - "{ readonly trustedApps: string; readonly eventFilters: string; readonly blocklist: string; readonly policyResponseTroubleshooting: { full_disk_access: string; }; }" + "{ readonly trustedApps: string; readonly eventFilters: string; readonly blocklist: string; readonly policyResponseTroubleshooting: { full_disk_access: string; macos_system_ext: string; }; }" ], "path": "packages/kbn-doc-links/src/types.ts", "deprecated": false diff --git a/api_docs/kbn_doc_links.mdx b/api_docs/kbn_doc_links.mdx index 3dca7c16dcc20..00ef15c27f6c6 100644 --- a/api_docs/kbn_doc_links.mdx +++ b/api_docs/kbn_doc_links.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-doc-links title: "@kbn/doc-links" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/doc-links plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/doc-links'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_docs_utils.mdx b/api_docs/kbn_docs_utils.mdx index 61fb95177b098..1745e95ece2ba 100644 --- a/api_docs/kbn_docs_utils.mdx +++ b/api_docs/kbn_docs_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-docs-utils title: "@kbn/docs-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/docs-utils plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/docs-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_es_archiver.mdx b/api_docs/kbn_es_archiver.mdx index be64967634db8..59a8a0413c64c 100644 --- a/api_docs/kbn_es_archiver.mdx +++ b/api_docs/kbn_es_archiver.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-es-archiver title: "@kbn/es-archiver" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/es-archiver plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-archiver'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_es_errors.mdx b/api_docs/kbn_es_errors.mdx index 00a3f88a220be..65d64b1d89a75 100644 --- a/api_docs/kbn_es_errors.mdx +++ b/api_docs/kbn_es_errors.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-es-errors title: "@kbn/es-errors" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/es-errors plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-errors'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_es_query.mdx b/api_docs/kbn_es_query.mdx index 0cc5656857776..9084761693e28 100644 --- a/api_docs/kbn_es_query.mdx +++ b/api_docs/kbn_es_query.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-es-query title: "@kbn/es-query" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/es-query plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-query'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_eslint_plugin_imports.mdx b/api_docs/kbn_eslint_plugin_imports.mdx index 19d8ec9025c1b..46381bd6e4ed9 100644 --- a/api_docs/kbn_eslint_plugin_imports.mdx +++ b/api_docs/kbn_eslint_plugin_imports.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-eslint-plugin-imports title: "@kbn/eslint-plugin-imports" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/eslint-plugin-imports plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/eslint-plugin-imports'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_field_types.mdx b/api_docs/kbn_field_types.mdx index 42acc093c6c47..851a8217b16ca 100644 --- a/api_docs/kbn_field_types.mdx +++ b/api_docs/kbn_field_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-field-types title: "@kbn/field-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/field-types plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/field-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_find_used_node_modules.mdx b/api_docs/kbn_find_used_node_modules.mdx index 3b68d3908f8c9..c1e107406b828 100644 --- a/api_docs/kbn_find_used_node_modules.mdx +++ b/api_docs/kbn_find_used_node_modules.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-find-used-node-modules title: "@kbn/find-used-node-modules" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/find-used-node-modules plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/find-used-node-modules'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_generate.mdx b/api_docs/kbn_generate.mdx index cc4ba1e51e0a3..b77f7771f716b 100644 --- a/api_docs/kbn_generate.mdx +++ b/api_docs/kbn_generate.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-generate title: "@kbn/generate" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/generate plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/generate'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_handlebars.mdx b/api_docs/kbn_handlebars.mdx index 37fa95206ecbb..c9dfd16d549fe 100644 --- a/api_docs/kbn_handlebars.mdx +++ b/api_docs/kbn_handlebars.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-handlebars title: "@kbn/handlebars" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/handlebars plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/handlebars'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_hapi_mocks.devdocs.json b/api_docs/kbn_hapi_mocks.devdocs.json new file mode 100644 index 0000000000000..0b2399bcba92a --- /dev/null +++ b/api_docs/kbn_hapi_mocks.devdocs.json @@ -0,0 +1,277 @@ +{ + "id": "@kbn/hapi-mocks", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [ + { + "parentPluginId": "@kbn/hapi-mocks", + "id": "def-server.hapiMocks", + "type": "Object", + "tags": [], + "label": "hapiMocks", + "description": [], + "path": "packages/kbn-hapi-mocks/src/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/hapi-mocks", + "id": "def-server.hapiMocks.createRequest", + "type": "Function", + "tags": [], + "label": "createRequest", + "description": [], + "signature": [ + "(customization?: ", + "DeepPartialObject", + "<", + "Request", + ">) => ", + "Request" + ], + "path": "packages/kbn-hapi-mocks/src/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/hapi-mocks", + "id": "def-server.hapiMocks.createRequest.$1", + "type": "Object", + "tags": [], + "label": "customization", + "description": [], + "signature": [ + "{ app?: ", + "DeepPartialObject", + "<", + "RequestApplicationState", + "> | undefined; readonly auth?: ", + "DeepPartialObject", + "<", + "RequestAuth", + "> | undefined; events?: ", + "DeepPartialObject", + "<", + "RequestEvents", + "> | undefined; readonly headers?: ", + "DeepPartialObject", + "<", + "Util", + ".Dictionary> | undefined; readonly info?: ", + "DeepPartialObject", + "<", + "RequestInfo", + "> | undefined; readonly logs?: ", + "DeepPartialArray", + "<", + "RequestLog", + "> | undefined; readonly method?: ", + "Util", + ".HTTP_METHODS_PARTIAL_LOWERCASE | undefined; readonly mime?: string | undefined; readonly orig?: ", + "DeepPartialObject", + "<", + "RequestOrig", + "> | undefined; readonly params?: ", + "DeepPartialObject", + "<", + "Util", + ".Dictionary> | undefined; readonly paramsArray?: ", + "DeepPartialArray", + " | undefined; readonly path?: string | undefined; readonly payload?: string | object | ", + "DeepPartialObject", + "<", + "Readable", + "> | ", + "DeepPartialObject", + " | undefined; plugins?: ", + "DeepPartialObject", + "<", + "PluginsStates", + "> | undefined; readonly pre?: ", + "DeepPartialObject", + "<", + "Util", + ".Dictionary> | undefined; response?: ", + "DeepPartialObject", + "<", + "Boom", + "> | ", + "DeepPartialObject", + "<", + "ResponseObject", + "> | undefined; readonly preResponses?: ", + "DeepPartialObject", + "<", + "Util", + ".Dictionary> | undefined; readonly query?: ", + "DeepPartialObject", + "<", + "RequestQuery", + "> | undefined; readonly raw?: ", + "DeepPartialObject", + "<{ req: ", + "IncomingMessage", + "; res: ", + "ServerResponse", + "; }> | undefined; readonly route?: ", + "DeepPartialObject", + "<", + "RequestRoute", + "> | undefined; server?: ", + "DeepPartialObject", + "<", + "Server", + "> | undefined; readonly state?: ", + "DeepPartialObject", + "<", + "Util", + ".Dictionary> | undefined; readonly url?: ", + "DeepPartialObject", + "<", + "URL", + "> | undefined; active?: ", + "DeepPartialObject", + "<() => boolean> | undefined; generateResponse?: ", + "DeepPartialObject", + "<(source: string | object | null, options?: { variety?: string | undefined; prepare?: ((response: ", + "ResponseObject", + ") => Promise<", + "ResponseObject", + ">) | undefined; marshal?: ((response: ", + "ResponseObject", + ") => Promise<", + "ResponseValue", + ">) | undefined; close?: ((response: ", + "ResponseObject", + ") => void) | undefined; } | undefined) => ", + "ResponseObject", + "> | undefined; log?: ", + "DeepPartialObject", + "<(tags: string | string[], data?: string | object | (() => string | object) | undefined) => void> | undefined; setMethod?: ", + "DeepPartialObject", + "<(method: ", + "Util", + ".HTTP_METHODS_PARTIAL) => void> | undefined; setUrl?: ", + "DeepPartialObject", + "<(url: string | ", + "URL", + ", stripTrailingSlash?: boolean | undefined) => void> | undefined; cookieAuth?: ", + "DeepPartialObject", + "<{ set(session: object): void; set(key: string, value: string | object): void; clear(key?: string | undefined): void; ttl(milliseconds: number): void; }> | undefined; registerEvent?: ", + "DeepPartialObject", + "<(events: ", + "Event", + " | ", + "Event", + "[]) => void> | undefined; registerPodium?: ", + "DeepPartialObject", + "<(podiums: ", + "node_modules/@hapi/podium/lib/index", + " | ", + "node_modules/@hapi/podium/lib/index", + "[]) => void> | undefined; emit?: ", + "DeepPartialObject", + "<(criteria: string | ", + "EmitCriteria", + ", data?: any) => Promise> | undefined; on?: ", + "DeepPartialObject", + "<{ (criteria: string | ", + "CriteriaObject", + ", listener: ", + "Listener", + ", context?: Tcontext | undefined): ", + "Request", + "; (criteria: string | ", + "CriteriaObject", + ", listener: ", + "Listener", + ", context?: Tcontext | undefined): ", + "Request", + "; }> | undefined; addListener?: ", + "DeepPartialObject", + "<{ (criteria: string | ", + "CriteriaObject", + ", listener: ", + "Listener", + ", context?: Tcontext | undefined): ", + "Request", + "; (criteria: string | ", + "CriteriaObject", + ", listener: ", + "Listener", + ", context?: Tcontext | undefined): ", + "Request", + "; }> | undefined; once?: ", + "DeepPartialObject", + "<{ (criteria: string | Omit<", + "CriteriaObject", + ", \"count\">, listener: ", + "Listener", + ", context?: Tcontext | undefined): ", + "Request", + "; (criteria: string | Omit<", + "CriteriaObject", + ", \"count\">, listener: ", + "Listener", + ", context?: Tcontext | undefined): ", + "Request", + "; (criteria: string | Omit<", + "CriteriaObject", + ", \"count\">): Promise; (criteria: string | Omit<", + "CriteriaObject", + ", \"count\">): Promise; }> | undefined; removeListener?: ", + "DeepPartialObject", + "<(name: string, listener: ", + "Listener", + ") => ", + "Request", + "> | undefined; removeAllListeners?: ", + "DeepPartialObject", + "<(name: string) => ", + "Request", + "> | undefined; hasListeners?: ", + "DeepPartialObject", + "<(name: string) => boolean> | undefined; }" + ], + "path": "packages/kbn-hapi-mocks/src/request.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + } + ] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_hapi_mocks.mdx b/api_docs/kbn_hapi_mocks.mdx new file mode 100644 index 0000000000000..74193484aaa01 --- /dev/null +++ b/api_docs/kbn_hapi_mocks.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnHapiMocksPluginApi +slug: /kibana-dev-docs/api/kbn-hapi-mocks +title: "@kbn/hapi-mocks" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/hapi-mocks plugin +date: 2022-07-13 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/hapi-mocks'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnHapiMocksObj from './kbn_hapi_mocks.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 3 | 0 | 3 | 0 | + +## Server + +### Objects + + diff --git a/api_docs/kbn_home_sample_data_cards.mdx b/api_docs/kbn_home_sample_data_cards.mdx index 6f990142cf388..ff0d667da085f 100644 --- a/api_docs/kbn_home_sample_data_cards.mdx +++ b/api_docs/kbn_home_sample_data_cards.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-home-sample-data-cards title: "@kbn/home-sample-data-cards" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/home-sample-data-cards plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/home-sample-data-cards'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_i18n.mdx b/api_docs/kbn_i18n.mdx index 7d31d9236dfbe..c8164c7778e15 100644 --- a/api_docs/kbn_i18n.mdx +++ b/api_docs/kbn_i18n.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-i18n title: "@kbn/i18n" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/i18n plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/i18n'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_import_resolver.mdx b/api_docs/kbn_import_resolver.mdx index 543c395f2e9f7..95f220bd9fb5b 100644 --- a/api_docs/kbn_import_resolver.mdx +++ b/api_docs/kbn_import_resolver.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-import-resolver title: "@kbn/import-resolver" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/import-resolver plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/import-resolver'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_interpreter.mdx b/api_docs/kbn_interpreter.mdx index 7d25c737e5bab..ea07bac765030 100644 --- a/api_docs/kbn_interpreter.mdx +++ b/api_docs/kbn_interpreter.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-interpreter title: "@kbn/interpreter" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/interpreter plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/interpreter'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_io_ts_utils.mdx b/api_docs/kbn_io_ts_utils.mdx index 9238e69ad672d..2b5ce56a5d60f 100644 --- a/api_docs/kbn_io_ts_utils.mdx +++ b/api_docs/kbn_io_ts_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-io-ts-utils title: "@kbn/io-ts-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/io-ts-utils plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/io-ts-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_jest_serializers.mdx b/api_docs/kbn_jest_serializers.mdx index b87d2d3a58c8e..a994586c8a74e 100644 --- a/api_docs/kbn_jest_serializers.mdx +++ b/api_docs/kbn_jest_serializers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-jest-serializers title: "@kbn/jest-serializers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/jest-serializers plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/jest-serializers'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_kibana_json_schema.mdx b/api_docs/kbn_kibana_json_schema.mdx index 1beae227c03d8..e351775e76cee 100644 --- a/api_docs/kbn_kibana_json_schema.mdx +++ b/api_docs/kbn_kibana_json_schema.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-kibana-json-schema title: "@kbn/kibana-json-schema" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/kibana-json-schema plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/kibana-json-schema'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_logging.devdocs.json b/api_docs/kbn_logging.devdocs.json index 29d30a1c83b2d..0a3d4f130790c 100644 --- a/api_docs/kbn_logging.devdocs.json +++ b/api_docs/kbn_logging.devdocs.json @@ -658,7 +658,7 @@ "label": "EcsEventType", "description": [], "signature": [ - "\"start\" | \"error\" | \"user\" | \"info\" | \"group\" | \"end\" | \"admin\" | \"protocol\" | \"connection\" | \"access\" | \"allowed\" | \"change\" | \"creation\" | \"deletion\" | \"denied\" | \"installation\"" + "\"start\" | \"error\" | \"user\" | \"info\" | \"group\" | \"end\" | \"admin\" | \"protocol\" | \"access\" | \"allowed\" | \"change\" | \"connection\" | \"creation\" | \"deletion\" | \"denied\" | \"installation\"" ], "path": "packages/kbn-logging/src/ecs/event.ts", "deprecated": false, diff --git a/api_docs/kbn_logging.mdx b/api_docs/kbn_logging.mdx index ddced69be4bf4..d2b10fc180773 100644 --- a/api_docs/kbn_logging.mdx +++ b/api_docs/kbn_logging.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-logging title: "@kbn/logging" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/logging plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/logging'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_logging_mocks.mdx b/api_docs/kbn_logging_mocks.mdx index d3bc892733c32..e6ebec63e1632 100644 --- a/api_docs/kbn_logging_mocks.mdx +++ b/api_docs/kbn_logging_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-logging-mocks title: "@kbn/logging-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/logging-mocks plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/logging-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_mapbox_gl.mdx b/api_docs/kbn_mapbox_gl.mdx index 8a07a4f5b9541..28115f56adc24 100644 --- a/api_docs/kbn_mapbox_gl.mdx +++ b/api_docs/kbn_mapbox_gl.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-mapbox-gl title: "@kbn/mapbox-gl" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/mapbox-gl plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/mapbox-gl'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_ml_agg_utils.mdx b/api_docs/kbn_ml_agg_utils.mdx index 8be196fb4cea6..d9073ce0d303d 100644 --- a/api_docs/kbn_ml_agg_utils.mdx +++ b/api_docs/kbn_ml_agg_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ml-agg-utils title: "@kbn/ml-agg-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ml-agg-utils plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-agg-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_ml_is_populated_object.mdx b/api_docs/kbn_ml_is_populated_object.mdx index 3ef1b0339bd8b..a9e31ddb35448 100644 --- a/api_docs/kbn_ml_is_populated_object.mdx +++ b/api_docs/kbn_ml_is_populated_object.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ml-is-populated-object title: "@kbn/ml-is-populated-object" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ml-is-populated-object plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-is-populated-object'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_ml_string_hash.mdx b/api_docs/kbn_ml_string_hash.mdx index 76a7fcb617e0e..f9f2be975e065 100644 --- a/api_docs/kbn_ml_string_hash.mdx +++ b/api_docs/kbn_ml_string_hash.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ml-string-hash title: "@kbn/ml-string-hash" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ml-string-hash plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-string-hash'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_monaco.mdx b/api_docs/kbn_monaco.mdx index a91689dd10cd9..c51c233e79489 100644 --- a/api_docs/kbn_monaco.mdx +++ b/api_docs/kbn_monaco.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-monaco title: "@kbn/monaco" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/monaco plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/monaco'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_optimizer.mdx b/api_docs/kbn_optimizer.mdx index a69a781be417a..26d65a3ead693 100644 --- a/api_docs/kbn_optimizer.mdx +++ b/api_docs/kbn_optimizer.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-optimizer title: "@kbn/optimizer" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/optimizer plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/optimizer'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_optimizer_webpack_helpers.mdx b/api_docs/kbn_optimizer_webpack_helpers.mdx index 7218aa0e8fabe..401301b348c9e 100644 --- a/api_docs/kbn_optimizer_webpack_helpers.mdx +++ b/api_docs/kbn_optimizer_webpack_helpers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-optimizer-webpack-helpers title: "@kbn/optimizer-webpack-helpers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/optimizer-webpack-helpers plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/optimizer-webpack-helpers'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_performance_testing_dataset_extractor.mdx b/api_docs/kbn_performance_testing_dataset_extractor.mdx index 6e6e4265b3eb3..f57e25cf322cb 100644 --- a/api_docs/kbn_performance_testing_dataset_extractor.mdx +++ b/api_docs/kbn_performance_testing_dataset_extractor.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-performance-testing-dataset-extractor title: "@kbn/performance-testing-dataset-extractor" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/performance-testing-dataset-extractor plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/performance-testing-dataset-extractor'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_plugin_discovery.mdx b/api_docs/kbn_plugin_discovery.mdx index 59c92b6015f0d..55e9a6b95abc0 100644 --- a/api_docs/kbn_plugin_discovery.mdx +++ b/api_docs/kbn_plugin_discovery.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-discovery title: "@kbn/plugin-discovery" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/plugin-discovery plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-discovery'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_plugin_generator.mdx b/api_docs/kbn_plugin_generator.mdx index 20906a9bac8b4..e4578b1f4a432 100644 --- a/api_docs/kbn_plugin_generator.mdx +++ b/api_docs/kbn_plugin_generator.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-generator title: "@kbn/plugin-generator" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/plugin-generator plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-generator'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_plugin_helpers.mdx b/api_docs/kbn_plugin_helpers.mdx index 1206d063b0506..4374d72505a63 100644 --- a/api_docs/kbn_plugin_helpers.mdx +++ b/api_docs/kbn_plugin_helpers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-helpers title: "@kbn/plugin-helpers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/plugin-helpers plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-helpers'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_pm.mdx b/api_docs/kbn_pm.mdx index cafaed833a306..da5a74d30c957 100644 --- a/api_docs/kbn_pm.mdx +++ b/api_docs/kbn_pm.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-pm title: "@kbn/pm" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/pm plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/pm'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_react_field.mdx b/api_docs/kbn_react_field.mdx index d40a6eda8c20d..ca8e694697cd0 100644 --- a/api_docs/kbn_react_field.mdx +++ b/api_docs/kbn_react_field.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-react-field title: "@kbn/react-field" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/react-field plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/react-field'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_rule_data_utils.mdx b/api_docs/kbn_rule_data_utils.mdx index 6006d71fd1992..5482e0bedb1a2 100644 --- a/api_docs/kbn_rule_data_utils.mdx +++ b/api_docs/kbn_rule_data_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-rule-data-utils title: "@kbn/rule-data-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/rule-data-utils plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/rule-data-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_scalability_simulation_generator.mdx b/api_docs/kbn_scalability_simulation_generator.mdx index c00a04346514d..e79d76f12349e 100644 --- a/api_docs/kbn_scalability_simulation_generator.mdx +++ b/api_docs/kbn_scalability_simulation_generator.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-scalability-simulation-generator title: "@kbn/scalability-simulation-generator" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/scalability-simulation-generator plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/scalability-simulation-generator'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_autocomplete.mdx b/api_docs/kbn_securitysolution_autocomplete.mdx index b923af6144a01..e8ccd05d48c9a 100644 --- a/api_docs/kbn_securitysolution_autocomplete.mdx +++ b/api_docs/kbn_securitysolution_autocomplete.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-autocomplete title: "@kbn/securitysolution-autocomplete" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-autocomplete plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-autocomplete'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_es_utils.mdx b/api_docs/kbn_securitysolution_es_utils.mdx index 75139091f24f2..6c944bcd5e19e 100644 --- a/api_docs/kbn_securitysolution_es_utils.mdx +++ b/api_docs/kbn_securitysolution_es_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-es-utils title: "@kbn/securitysolution-es-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-es-utils plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-es-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_hook_utils.mdx b/api_docs/kbn_securitysolution_hook_utils.mdx index 390443eb1c136..6728b6ba14dee 100644 --- a/api_docs/kbn_securitysolution_hook_utils.mdx +++ b/api_docs/kbn_securitysolution_hook_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-hook-utils title: "@kbn/securitysolution-hook-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-hook-utils plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-hook-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx b/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx index 5e686027803f7..347d01b914dbc 100644 --- a/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-alerting-types title: "@kbn/securitysolution-io-ts-alerting-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-io-ts-alerting-types plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-alerting-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_io_ts_list_types.mdx b/api_docs/kbn_securitysolution_io_ts_list_types.mdx index 05725ece4016d..833b86fa341b0 100644 --- a/api_docs/kbn_securitysolution_io_ts_list_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_list_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-list-types title: "@kbn/securitysolution-io-ts-list-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-io-ts-list-types plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-list-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_io_ts_types.mdx b/api_docs/kbn_securitysolution_io_ts_types.mdx index 74128e4ce61fd..762606a0b72b1 100644 --- a/api_docs/kbn_securitysolution_io_ts_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-types title: "@kbn/securitysolution-io-ts-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-io-ts-types plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_io_ts_utils.mdx b/api_docs/kbn_securitysolution_io_ts_utils.mdx index 679bc61bf693f..71a19be9283bf 100644 --- a/api_docs/kbn_securitysolution_io_ts_utils.mdx +++ b/api_docs/kbn_securitysolution_io_ts_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-utils title: "@kbn/securitysolution-io-ts-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-io-ts-utils plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_list_api.mdx b/api_docs/kbn_securitysolution_list_api.mdx index 74207b0e55ec1..b85e37444435f 100644 --- a/api_docs/kbn_securitysolution_list_api.mdx +++ b/api_docs/kbn_securitysolution_list_api.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-api title: "@kbn/securitysolution-list-api" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-list-api plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-api'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_list_constants.mdx b/api_docs/kbn_securitysolution_list_constants.mdx index 170517d9be2ef..fe27d37be1ed7 100644 --- a/api_docs/kbn_securitysolution_list_constants.mdx +++ b/api_docs/kbn_securitysolution_list_constants.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-constants title: "@kbn/securitysolution-list-constants" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-list-constants plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-constants'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_list_hooks.mdx b/api_docs/kbn_securitysolution_list_hooks.mdx index ae32ed89333ef..36797c388c072 100644 --- a/api_docs/kbn_securitysolution_list_hooks.mdx +++ b/api_docs/kbn_securitysolution_list_hooks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-hooks title: "@kbn/securitysolution-list-hooks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-list-hooks plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-hooks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_list_utils.mdx b/api_docs/kbn_securitysolution_list_utils.mdx index 153a00c98dc98..192b8ec9d7554 100644 --- a/api_docs/kbn_securitysolution_list_utils.mdx +++ b/api_docs/kbn_securitysolution_list_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-utils title: "@kbn/securitysolution-list-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-list-utils plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_rules.mdx b/api_docs/kbn_securitysolution_rules.mdx index 258ec99b73502..26020f321d906 100644 --- a/api_docs/kbn_securitysolution_rules.mdx +++ b/api_docs/kbn_securitysolution_rules.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-rules title: "@kbn/securitysolution-rules" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-rules plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-rules'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_t_grid.mdx b/api_docs/kbn_securitysolution_t_grid.mdx index a54e2eb038abb..39c4712d09079 100644 --- a/api_docs/kbn_securitysolution_t_grid.mdx +++ b/api_docs/kbn_securitysolution_t_grid.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-t-grid title: "@kbn/securitysolution-t-grid" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-t-grid plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-t-grid'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_utils.mdx b/api_docs/kbn_securitysolution_utils.mdx index da8f8a17a6df8..bb30474236d0c 100644 --- a/api_docs/kbn_securitysolution_utils.mdx +++ b/api_docs/kbn_securitysolution_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-utils title: "@kbn/securitysolution-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-utils plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_server_http_tools.mdx b/api_docs/kbn_server_http_tools.mdx index d148ccffae8d2..2ae808a2f4544 100644 --- a/api_docs/kbn_server_http_tools.mdx +++ b/api_docs/kbn_server_http_tools.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-server-http-tools title: "@kbn/server-http-tools" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/server-http-tools plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/server-http-tools'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_server_route_repository.mdx b/api_docs/kbn_server_route_repository.mdx index e0a86c00d9f48..a8d94e51fd268 100644 --- a/api_docs/kbn_server_route_repository.mdx +++ b/api_docs/kbn_server_route_repository.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-server-route-repository title: "@kbn/server-route-repository" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/server-route-repository plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/server-route-repository'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_button_toolbar.mdx b/api_docs/kbn_shared_ux_button_toolbar.mdx index 2a7a6e9eff832..4fc6f96dc869a 100644 --- a/api_docs/kbn_shared_ux_button_toolbar.mdx +++ b/api_docs/kbn_shared_ux_button_toolbar.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-button-toolbar title: "@kbn/shared-ux-button-toolbar" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-button-toolbar plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-button-toolbar'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_card_no_data.mdx b/api_docs/kbn_shared_ux_card_no_data.mdx index 3cdd2d2660a64..3120a76d22182 100644 --- a/api_docs/kbn_shared_ux_card_no_data.mdx +++ b/api_docs/kbn_shared_ux_card_no_data.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-card-no-data title: "@kbn/shared-ux-card-no-data" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-card-no-data plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-card-no-data'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_components.devdocs.json b/api_docs/kbn_shared_ux_components.devdocs.json index 36b5a90b05801..52bb9bcd5d8b0 100644 --- a/api_docs/kbn_shared_ux_components.devdocs.json +++ b/api_docs/kbn_shared_ux_components.devdocs.json @@ -66,43 +66,6 @@ "returnComment": [], "initialIsOpen": false }, - { - "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.KibanaPageTemplateSolutionNav", - "type": "Function", - "tags": [], - "label": "KibanaPageTemplateSolutionNav", - "description": [ - "\nA wrapper around EuiSideNav but also creates the appropriate title with optional solution logo" - ], - "signature": [ - "({ children, headingProps, icon, isOpenOnDesktop, items, mobileBreakpoints, closeFlyoutButtonPosition, name, onCollapse, canBeCollapsed, ...rest }: React.PropsWithChildren<", - "KibanaPageTemplateSolutionNavProps", - ">) => JSX.Element" - ], - "path": "packages/kbn-shared-ux-components/src/page_template/solution_nav/solution_nav.tsx", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.KibanaPageTemplateSolutionNav.$1", - "type": "CompoundType", - "tags": [], - "label": "{\n children,\n headingProps,\n icon,\n isOpenOnDesktop = false,\n items,\n mobileBreakpoints = ['xs', 's'],\n closeFlyoutButtonPosition = 'outside',\n name,\n onCollapse,\n canBeCollapsed = true,\n ...rest\n}", - "description": [], - "signature": [ - "React.PropsWithChildren<", - "KibanaPageTemplateSolutionNavProps", - ">" - ], - "path": "packages/kbn-shared-ux-components/src/page_template/solution_nav/solution_nav.tsx", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, { "parentPluginId": "@kbn/shared-ux-components", "id": "def-common.NoDataConfigPage", @@ -273,7 +236,7 @@ " | undefined; fullHeight?: boolean | \"noscroll\" | undefined; minHeight?: ", "Property", ".MinHeight | undefined; } & { isEmptyState?: boolean | undefined; solutionNav?: ", - "KibanaPageTemplateSolutionNavProps", + "SolutionNavProps", " | undefined; noDataConfig?: ", { "pluginId": "@kbn/shared-ux-components", diff --git a/api_docs/kbn_shared_ux_components.mdx b/api_docs/kbn_shared_ux_components.mdx index 62fd9dee78f14..55b064588053a 100644 --- a/api_docs/kbn_shared_ux_components.mdx +++ b/api_docs/kbn_shared_ux_components.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-components title: "@kbn/shared-ux-components" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-components plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-components'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 13 | 0 | 7 | 1 | +| 11 | 0 | 6 | 0 | ## Common diff --git a/api_docs/kbn_shared_ux_page_analytics_no_data.mdx b/api_docs/kbn_shared_ux_page_analytics_no_data.mdx index e5c84a2b966c9..b2c92e8913396 100644 --- a/api_docs/kbn_shared_ux_page_analytics_no_data.mdx +++ b/api_docs/kbn_shared_ux_page_analytics_no_data.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-analytics-no-data title: "@kbn/shared-ux-page-analytics-no-data" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-page-analytics-no-data plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-analytics-no-data'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_page_kibana_no_data.mdx b/api_docs/kbn_shared_ux_page_kibana_no_data.mdx index f2b0042c0ac62..d1c4b518a2b54 100644 --- a/api_docs/kbn_shared_ux_page_kibana_no_data.mdx +++ b/api_docs/kbn_shared_ux_page_kibana_no_data.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-kibana-no-data title: "@kbn/shared-ux-page-kibana-no-data" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-page-kibana-no-data plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-kibana-no-data'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_page_solution_nav.devdocs.json b/api_docs/kbn_shared_ux_page_solution_nav.devdocs.json new file mode 100644 index 0000000000000..7331e1f6ac1e0 --- /dev/null +++ b/api_docs/kbn_shared_ux_page_solution_nav.devdocs.json @@ -0,0 +1,131 @@ +{ + "id": "@kbn/shared-ux-page-solution-nav", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/shared-ux-page-solution-nav", + "id": "def-common.SolutionNav", + "type": "Function", + "tags": [], + "label": "SolutionNav", + "description": [ + "\nA wrapper around `EuiSideNav` that includes the appropriate title with optional solution logo." + ], + "signature": [ + "({ children, headingProps, icon, isOpenOnDesktop, items, mobileBreakpoints, closeFlyoutButtonPosition, name, onCollapse, canBeCollapsed, ...rest }: React.PropsWithChildren<", + { + "pluginId": "@kbn/shared-ux-page-solution-nav", + "scope": "common", + "docId": "kibKbnSharedUxPageSolutionNavPluginApi", + "section": "def-common.SolutionNavProps", + "text": "SolutionNavProps" + }, + ">) => JSX.Element" + ], + "path": "packages/shared-ux/page/solution_nav/src/solution_nav.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-page-solution-nav", + "id": "def-common.SolutionNav.$1", + "type": "CompoundType", + "tags": [], + "label": "{\n children,\n headingProps,\n icon,\n isOpenOnDesktop = false,\n items,\n mobileBreakpoints = ['xs', 's'],\n closeFlyoutButtonPosition = 'outside',\n name,\n onCollapse,\n canBeCollapsed = true,\n ...rest\n}", + "description": [], + "signature": [ + "React.PropsWithChildren<", + { + "pluginId": "@kbn/shared-ux-page-solution-nav", + "scope": "common", + "docId": "kibKbnSharedUxPageSolutionNavPluginApi", + "section": "def-common.SolutionNavProps", + "text": "SolutionNavProps" + }, + ">" + ], + "path": "packages/shared-ux/page/solution_nav/src/solution_nav.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-page-solution-nav", + "id": "def-common.withSolutionNav", + "type": "Function", + "tags": [], + "label": "withSolutionNav", + "description": [], + "signature": [ + "

(WrappedComponent: React.ComponentType

) => { (props: Props

): JSX.Element; displayName: string; }" + ], + "path": "packages/shared-ux/page/solution_nav/src/with_solution_nav.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-page-solution-nav", + "id": "def-common.withSolutionNav.$1", + "type": "CompoundType", + "tags": [], + "label": "WrappedComponent", + "description": [], + "signature": [ + "React.ComponentType

" + ], + "path": "packages/shared-ux/page/solution_nav/src/with_solution_nav.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/shared-ux-page-solution-nav", + "id": "def-common.SolutionNavProps", + "type": "Type", + "tags": [], + "label": "SolutionNavProps", + "description": [ + "\nProps for the `SolutionNav` component." + ], + "signature": [ + "Omit<", + "EuiSideNavProps", + "<{}>, \"children\" | \"heading\" | \"items\"> & { name: string; icon?: ", + "IconType", + " | undefined; items?: ", + "EuiSideNavItemType", + "<{}>[] | undefined; children?: React.ReactNode; closeFlyoutButtonPosition?: \"outside\" | \"inside\" | undefined; isOpenOnDesktop?: boolean | undefined; onCollapse?: (() => void) | undefined; canBeCollapsed?: boolean | undefined; }" + ], + "path": "packages/shared-ux/page/solution_nav/src/solution_nav.tsx", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_shared_ux_page_solution_nav.mdx b/api_docs/kbn_shared_ux_page_solution_nav.mdx new file mode 100644 index 0000000000000..ec5eb2ca715e7 --- /dev/null +++ b/api_docs/kbn_shared_ux_page_solution_nav.mdx @@ -0,0 +1,30 @@ +--- +id: kibKbnSharedUxPageSolutionNavPluginApi +slug: /kibana-dev-docs/api/kbn-shared-ux-page-solution-nav +title: "@kbn/shared-ux-page-solution-nav" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/shared-ux-page-solution-nav plugin +date: 2022-07-13 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-solution-nav'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnSharedUxPageSolutionNavObj from './kbn_shared_ux_page_solution_nav.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 5 | 0 | 3 | 0 | + +## Common + +### Functions + + +### Consts, variables and types + + diff --git a/api_docs/kbn_shared_ux_prompt_no_data_views.mdx b/api_docs/kbn_shared_ux_prompt_no_data_views.mdx index 73eba3b605169..3cd347e515853 100644 --- a/api_docs/kbn_shared_ux_prompt_no_data_views.mdx +++ b/api_docs/kbn_shared_ux_prompt_no_data_views.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-prompt-no-data-views title: "@kbn/shared-ux-prompt-no-data-views" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-prompt-no-data-views plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-prompt-no-data-views'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_services.mdx b/api_docs/kbn_shared_ux_services.mdx index 105ace97c1e66..0d2aefce71fdc 100644 --- a/api_docs/kbn_shared_ux_services.mdx +++ b/api_docs/kbn_shared_ux_services.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-services title: "@kbn/shared-ux-services" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-services plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-services'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_storybook.mdx b/api_docs/kbn_shared_ux_storybook.mdx index 585e3c74b52f8..42b4f931b1d85 100644 --- a/api_docs/kbn_shared_ux_storybook.mdx +++ b/api_docs/kbn_shared_ux_storybook.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-storybook title: "@kbn/shared-ux-storybook" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-storybook plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-storybook'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_utility.mdx b/api_docs/kbn_shared_ux_utility.mdx index df672110d3e72..711fb0e0cd990 100644 --- a/api_docs/kbn_shared_ux_utility.mdx +++ b/api_docs/kbn_shared_ux_utility.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-utility title: "@kbn/shared-ux-utility" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-utility plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-utility'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_sort_package_json.mdx b/api_docs/kbn_sort_package_json.mdx index b167971389633..5ae42cf4f2d29 100644 --- a/api_docs/kbn_sort_package_json.mdx +++ b/api_docs/kbn_sort_package_json.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-sort-package-json title: "@kbn/sort-package-json" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/sort-package-json plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/sort-package-json'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_std.mdx b/api_docs/kbn_std.mdx index de1b7d0c7f155..00e47f058bb0e 100644 --- a/api_docs/kbn_std.mdx +++ b/api_docs/kbn_std.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-std title: "@kbn/std" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/std plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/std'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_stdio_dev_helpers.mdx b/api_docs/kbn_stdio_dev_helpers.mdx index e2196590d5ae7..a3912ad4534f4 100644 --- a/api_docs/kbn_stdio_dev_helpers.mdx +++ b/api_docs/kbn_stdio_dev_helpers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-stdio-dev-helpers title: "@kbn/stdio-dev-helpers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/stdio-dev-helpers plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/stdio-dev-helpers'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_storybook.mdx b/api_docs/kbn_storybook.mdx index 696e54a2239f3..6bd0a35d7781a 100644 --- a/api_docs/kbn_storybook.mdx +++ b/api_docs/kbn_storybook.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-storybook title: "@kbn/storybook" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/storybook plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/storybook'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_telemetry_tools.mdx b/api_docs/kbn_telemetry_tools.mdx index d79e5f6fa96d7..01f7ecfa62fa7 100644 --- a/api_docs/kbn_telemetry_tools.mdx +++ b/api_docs/kbn_telemetry_tools.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-telemetry-tools title: "@kbn/telemetry-tools" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/telemetry-tools plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/telemetry-tools'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_test.mdx b/api_docs/kbn_test.mdx index 2f4cc1419d3c2..e02a0e7631088 100644 --- a/api_docs/kbn_test.mdx +++ b/api_docs/kbn_test.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-test title: "@kbn/test" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/test plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_test_jest_helpers.mdx b/api_docs/kbn_test_jest_helpers.mdx index aee7aa18c3690..e5a7fbdfff162 100644 --- a/api_docs/kbn_test_jest_helpers.mdx +++ b/api_docs/kbn_test_jest_helpers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-test-jest-helpers title: "@kbn/test-jest-helpers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/test-jest-helpers plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test-jest-helpers'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_tooling_log.mdx b/api_docs/kbn_tooling_log.mdx index cbd597b456cf9..f5328706fcf4b 100644 --- a/api_docs/kbn_tooling_log.mdx +++ b/api_docs/kbn_tooling_log.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-tooling-log title: "@kbn/tooling-log" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/tooling-log plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/tooling-log'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_type_summarizer.mdx b/api_docs/kbn_type_summarizer.mdx index c570eccfc0519..f243d4dc40658 100644 --- a/api_docs/kbn_type_summarizer.mdx +++ b/api_docs/kbn_type_summarizer.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-type-summarizer title: "@kbn/type-summarizer" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/type-summarizer plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/type-summarizer'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_type_summarizer_core.mdx b/api_docs/kbn_type_summarizer_core.mdx index 8dcc913751043..82bdca5e9d8b2 100644 --- a/api_docs/kbn_type_summarizer_core.mdx +++ b/api_docs/kbn_type_summarizer_core.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-type-summarizer-core title: "@kbn/type-summarizer-core" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/type-summarizer-core plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/type-summarizer-core'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_typed_react_router_config.mdx b/api_docs/kbn_typed_react_router_config.mdx index e8b84f738a79f..3bb61421b625d 100644 --- a/api_docs/kbn_typed_react_router_config.mdx +++ b/api_docs/kbn_typed_react_router_config.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-typed-react-router-config title: "@kbn/typed-react-router-config" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/typed-react-router-config plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/typed-react-router-config'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_ui_theme.devdocs.json b/api_docs/kbn_ui_theme.devdocs.json index 04198954b33d1..08db88839686d 100644 --- a/api_docs/kbn_ui_theme.devdocs.json +++ b/api_docs/kbn_ui_theme.devdocs.json @@ -52,7 +52,7 @@ "label": "Theme", "description": [], "signature": [ - "{ euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiEmptyPromptContentMaxWidth: string; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" + "{ euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiEmptyPromptContentMaxWidth: string; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" ], "path": "packages/kbn-ui-theme/src/theme.ts", "deprecated": false, @@ -82,7 +82,7 @@ "label": "euiDarkVars", "description": [], "signature": [ - "{ euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiEmptyPromptContentMaxWidth: string; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" + "{ euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiEmptyPromptContentMaxWidth: string; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" ], "path": "packages/kbn-ui-theme/src/theme.ts", "deprecated": false, @@ -96,7 +96,7 @@ "label": "euiLightVars", "description": [], "signature": [ - "{ euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiEmptyPromptContentMaxWidth: string; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" + "{ euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiEmptyPromptContentMaxWidth: string; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" ], "path": "packages/kbn-ui-theme/src/theme.ts", "deprecated": false, @@ -112,7 +112,7 @@ "\nEUI Theme vars that automatically adjust to light/dark theme" ], "signature": [ - "{ euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiEmptyPromptContentMaxWidth: string; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" + "{ euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiEmptyPromptContentMaxWidth: string; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" ], "path": "packages/kbn-ui-theme/src/theme.ts", "deprecated": false, diff --git a/api_docs/kbn_ui_theme.mdx b/api_docs/kbn_ui_theme.mdx index 363ecf4ecafdf..1b007f581dd8f 100644 --- a/api_docs/kbn_ui_theme.mdx +++ b/api_docs/kbn_ui_theme.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ui-theme title: "@kbn/ui-theme" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ui-theme plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ui-theme'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_utility_types.devdocs.json b/api_docs/kbn_utility_types.devdocs.json index 3ad3c5339a00c..41399d411d722 100644 --- a/api_docs/kbn_utility_types.devdocs.json +++ b/api_docs/kbn_utility_types.devdocs.json @@ -12,6 +12,36 @@ "classes": [], "functions": [], "interfaces": [ + { + "parentPluginId": "@kbn/utility-types", + "id": "def-server.DeepPartialArray", + "type": "Interface", + "tags": [], + "label": "DeepPartialArray", + "description": [], + "signature": [ + { + "pluginId": "@kbn/utility-types", + "scope": "server", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-server.DeepPartialArray", + "text": "DeepPartialArray" + }, + " extends ", + { + "pluginId": "@kbn/utility-types", + "scope": "server", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-server.DeepPartial", + "text": "DeepPartial" + }, + "[]" + ], + "path": "packages/kbn-utility-types/src/index.ts", + "deprecated": false, + "children": [], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/utility-types", "id": "def-server.JsonArray", @@ -284,6 +314,60 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "@kbn/utility-types", + "id": "def-server.DeepPartial", + "type": "Type", + "tags": [], + "label": "DeepPartial", + "description": [ + "\nDeep partial version of a type." + ], + "signature": [ + "T extends any[] ? ", + { + "pluginId": "@kbn/utility-types", + "scope": "server", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-server.DeepPartialArray", + "text": "DeepPartialArray" + }, + " : T extends object ? ", + { + "pluginId": "@kbn/utility-types", + "scope": "server", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-server.DeepPartialObject", + "text": "DeepPartialObject" + }, + " : T" + ], + "path": "packages/kbn-utility-types/src/index.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/utility-types", + "id": "def-server.DeepPartialObject", + "type": "Type", + "tags": [], + "label": "DeepPartialObject", + "description": [], + "signature": [ + "{ [P in keyof T]+?: ", + { + "pluginId": "@kbn/utility-types", + "scope": "server", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-server.DeepPartial", + "text": "DeepPartial" + }, + " | undefined; }" + ], + "path": "packages/kbn-utility-types/src/index.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "@kbn/utility-types", "id": "def-server.Ensure", diff --git a/api_docs/kbn_utility_types.mdx b/api_docs/kbn_utility_types.mdx index 7700408705dbc..6464c4216069e 100644 --- a/api_docs/kbn_utility_types.mdx +++ b/api_docs/kbn_utility_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-utility-types title: "@kbn/utility-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/utility-types plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utility-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 29 | 0 | 10 | 1 | +| 32 | 0 | 12 | 1 | ## Server diff --git a/api_docs/kbn_utility_types_jest.mdx b/api_docs/kbn_utility_types_jest.mdx index 4c8683c9117d0..f1ca30178f685 100644 --- a/api_docs/kbn_utility_types_jest.mdx +++ b/api_docs/kbn_utility_types_jest.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-utility-types-jest title: "@kbn/utility-types-jest" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/utility-types-jest plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utility-types-jest'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_utils.mdx b/api_docs/kbn_utils.mdx index 88db19bf5e7d0..66520bf1db066 100644 --- a/api_docs/kbn_utils.mdx +++ b/api_docs/kbn_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-utils title: "@kbn/utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/utils plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kibana_overview.mdx b/api_docs/kibana_overview.mdx index fe087d8a4512a..ca0fd397bc94c 100644 --- a/api_docs/kibana_overview.mdx +++ b/api_docs/kibana_overview.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kibanaOverview title: "kibanaOverview" image: https://source.unsplash.com/400x175/?github summary: API docs for the kibanaOverview plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaOverview'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kibana_react.devdocs.json b/api_docs/kibana_react.devdocs.json index 8cfd07b7eae0c..921e088a13418 100644 --- a/api_docs/kibana_react.devdocs.json +++ b/api_docs/kibana_react.devdocs.json @@ -3775,8 +3775,8 @@ "label": "fetchError", "description": [], "signature": [ - "HttpFetchError", - " | undefined" + "IHttpFetchError", + " | undefined" ], "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "deprecated": false @@ -4353,13 +4353,7 @@ " | undefined; executionContext?: ", "ExecutionContextSetup", " | undefined; http?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", " | undefined; savedObjects?: ", { "pluginId": "core", @@ -5164,7 +5158,7 @@ "label": "eui", "description": [], "signature": [ - "{ euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiEmptyPromptContentMaxWidth: string; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" + "{ euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiEmptyPromptContentMaxWidth: string; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" ], "path": "src/plugins/kibana_react/common/eui_styled_components.tsx", "deprecated": false diff --git a/api_docs/kibana_react.mdx b/api_docs/kibana_react.mdx index f6a12a04b8f79..3c4b6ed0309fc 100644 --- a/api_docs/kibana_react.mdx +++ b/api_docs/kibana_react.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kibanaReact title: "kibanaReact" image: https://source.unsplash.com/400x175/?github summary: API docs for the kibanaReact plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaReact'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kibana_utils.devdocs.json b/api_docs/kibana_utils.devdocs.json index 478a5a30e5168..c9e6811dda262 100644 --- a/api_docs/kibana_utils.devdocs.json +++ b/api_docs/kibana_utils.devdocs.json @@ -3360,13 +3360,7 @@ "text": "NavigateToAppOptions" }, " | undefined) => Promise; basePath: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IBasePath", - "text": "IBasePath" - }, + "IBasePath", "; mapping: string | Mapping; toastNotifications: ", { "pluginId": "core", @@ -3484,13 +3478,7 @@ "label": "basePath", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IBasePath", - "text": "IBasePath" - } + "IBasePath" ], "path": "src/plugins/kibana_utils/public/history/redirect_when_missing.tsx", "deprecated": false @@ -7468,193 +7456,9 @@ "\n" ], "signature": [ - "(res: { custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | 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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }, err: ", + "(res: ", + "KibanaResponseFactory", + ", err: ", { "pluginId": "kibanaUtils", "scope": "server", @@ -7663,18 +7467,8 @@ "text": "KbnServerError" }, ") => ", - "KibanaResponse", - "" + "IKibanaResponse", + "" ], "path": "src/plugins/kibana_utils/server/report_server_error.ts", "deprecated": false, @@ -7682,200 +7476,14 @@ { "parentPluginId": "kibanaUtils", "id": "def-server.reportServerError.$1", - "type": "Object", + "type": "CompoundType", "tags": [], "label": "res", "description": [ "Formats a `KbnServerError` into a server error response" ], "signature": [ - "{ custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | 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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }" + "KibanaResponseFactory" ], "path": "src/plugins/kibana_utils/server/report_server_error.ts", "deprecated": false, diff --git a/api_docs/kibana_utils.mdx b/api_docs/kibana_utils.mdx index 0dd353e5c1bf5..e57d0e2d3b29e 100644 --- a/api_docs/kibana_utils.mdx +++ b/api_docs/kibana_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kibanaUtils title: "kibanaUtils" image: https://source.unsplash.com/400x175/?github summary: API docs for the kibanaUtils plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaUtils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kubernetes_security.mdx b/api_docs/kubernetes_security.mdx index 9eede5cefe95c..736bf513869f4 100644 --- a/api_docs/kubernetes_security.mdx +++ b/api_docs/kubernetes_security.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kubernetesSecurity title: "kubernetesSecurity" image: https://source.unsplash.com/400x175/?github summary: API docs for the kubernetesSecurity plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kubernetesSecurity'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/lens.devdocs.json b/api_docs/lens.devdocs.json index 08678f653942c..990dbbafbda78 100644 --- a/api_docs/lens.devdocs.json +++ b/api_docs/lens.devdocs.json @@ -159,6 +159,21 @@ ], "returnComment": [] }, + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.reportsEmbeddableLoad", + "type": "Function", + "tags": [], + "label": "reportsEmbeddableLoad", + "description": [], + "signature": [ + "() => boolean" + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "children": [], + "returnComment": [] + }, { "parentPluginId": "lens", "id": "def-public.Embeddable.supportedTriggers", @@ -1005,13 +1020,13 @@ }, { "parentPluginId": "lens", - "id": "def-public.DataLayerArgs.splitAccessor", - "type": "CompoundType", + "id": "def-public.DataLayerArgs.splitAccessors", + "type": "Array", "tags": [], - "label": "splitAccessor", + "label": "splitAccessors", "description": [], "signature": [ - "string | ", + "(string | ", { "pluginId": "visualizations", "scope": "common", @@ -1019,7 +1034,7 @@ "section": "def-common.ExpressionValueVisDimension", "text": "ExpressionValueVisDimension" }, - " | undefined" + ")[] | undefined" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false diff --git a/api_docs/lens.mdx b/api_docs/lens.mdx index 6fe37f4802cec..1c49503e62394 100644 --- a/api_docs/lens.mdx +++ b/api_docs/lens.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/lens title: "lens" image: https://source.unsplash.com/400x175/?github summary: API docs for the lens plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'lens'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 600 | 0 | 522 | 40 | +| 601 | 0 | 523 | 40 | ## Client diff --git a/api_docs/license_api_guard.devdocs.json b/api_docs/license_api_guard.devdocs.json index bb064fc65b964..ed124faba69f9 100644 --- a/api_docs/license_api_guard.devdocs.json +++ b/api_docs/license_api_guard.devdocs.json @@ -104,402 +104,16 @@ "section": "def-server.RequestHandler", "text": "RequestHandler" }, - " | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | 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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }>) => (ctx: Context, request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: { custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | 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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; 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" - }, + ") => (ctx: Context, request: ", + "KibanaRequest", + ", response: ", + "KibanaResponseFactory", + ") => ", + "IKibanaResponse", " | Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, + "IKibanaResponse", ">" ], "path": "x-pack/plugins/license_api_guard/server/license.ts", @@ -520,193 +134,9 @@ "section": "def-server.RequestHandler", "text": "RequestHandler" }, - " | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | 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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }>" + "" ], "path": "x-pack/plugins/license_api_guard/server/license.ts", "deprecated": false, diff --git a/api_docs/license_api_guard.mdx b/api_docs/license_api_guard.mdx index dfab565c56aa0..331b37523bb0b 100644 --- a/api_docs/license_api_guard.mdx +++ b/api_docs/license_api_guard.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/licenseApiGuard title: "licenseApiGuard" image: https://source.unsplash.com/400x175/?github summary: API docs for the licenseApiGuard plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licenseApiGuard'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/license_management.mdx b/api_docs/license_management.mdx index 43edf7db407ad..7d70dd7118c5b 100644 --- a/api_docs/license_management.mdx +++ b/api_docs/license_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/licenseManagement title: "licenseManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the licenseManagement plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licenseManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/licensing.devdocs.json b/api_docs/licensing.devdocs.json index a9b63f1e5b5ea..78ec93d24186e 100644 --- a/api_docs/licensing.devdocs.json +++ b/api_docs/licensing.devdocs.json @@ -915,193 +915,9 @@ "section": "def-server.RequestHandler", "text": "RequestHandler" }, - " | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | 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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }>) => ", + ") => ", { "pluginId": "core", "scope": "server", @@ -1109,193 +925,9 @@ "section": "def-server.RequestHandler", "text": "RequestHandler" }, - " | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | 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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }>" + "" ], "path": "x-pack/plugins/licensing/server/wrap_route_with_license_check.ts", "deprecated": false, @@ -1335,193 +967,9 @@ "section": "def-server.RequestHandler", "text": "RequestHandler" }, - " | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | 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", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }>" + "" ], "path": "x-pack/plugins/licensing/server/wrap_route_with_license_check.ts", "deprecated": false, diff --git a/api_docs/licensing.mdx b/api_docs/licensing.mdx index 7dd8d3b6a57cd..dce399078a361 100644 --- a/api_docs/licensing.mdx +++ b/api_docs/licensing.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/licensing title: "licensing" image: https://source.unsplash.com/400x175/?github summary: API docs for the licensing plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licensing'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/lists.mdx b/api_docs/lists.mdx index 4d4165bef760f..c5bf01ce7e4e4 100644 --- a/api_docs/lists.mdx +++ b/api_docs/lists.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/lists title: "lists" image: https://source.unsplash.com/400x175/?github summary: API docs for the lists plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'lists'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/management.mdx b/api_docs/management.mdx index ea54c9ba54274..d0fe3a0d4d7c6 100644 --- a/api_docs/management.mdx +++ b/api_docs/management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/management title: "management" image: https://source.unsplash.com/400x175/?github summary: API docs for the management plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'management'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/maps.devdocs.json b/api_docs/maps.devdocs.json index 8e94db12e16f0..f25dab745052a 100644 --- a/api_docs/maps.devdocs.json +++ b/api_docs/maps.devdocs.json @@ -314,6 +314,21 @@ ], "returnComment": [] }, + { + "parentPluginId": "maps", + "id": "def-public.MapEmbeddable.reportsEmbeddableLoad", + "type": "Function", + "tags": [], + "label": "reportsEmbeddableLoad", + "description": [], + "signature": [ + "() => boolean" + ], + "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", + "deprecated": false, + "children": [], + "returnComment": [] + }, { "parentPluginId": "maps", "id": "def-public.MapEmbeddable.inputIsRefType", diff --git a/api_docs/maps.mdx b/api_docs/maps.mdx index 6fc37732f82f3..c3af9f2b2b8ce 100644 --- a/api_docs/maps.mdx +++ b/api_docs/maps.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/maps title: "maps" image: https://source.unsplash.com/400x175/?github summary: API docs for the maps plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'maps'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [GIS](https://github.com/orgs/elastic/teams/kibana-gis) for questions re | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 248 | 0 | 247 | 24 | +| 249 | 0 | 248 | 24 | ## Client diff --git a/api_docs/maps_ems.mdx b/api_docs/maps_ems.mdx index 664b7266284e8..8d4fa80184619 100644 --- a/api_docs/maps_ems.mdx +++ b/api_docs/maps_ems.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/mapsEms title: "mapsEms" image: https://source.unsplash.com/400x175/?github summary: API docs for the mapsEms plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'mapsEms'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/ml.devdocs.json b/api_docs/ml.devdocs.json index 9ea813207c22a..27f79d5906f45 100644 --- a/api_docs/ml.devdocs.json +++ b/api_docs/ml.devdocs.json @@ -2887,13 +2887,7 @@ "text": "SavedObjectsClientContract" }, ", request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "): { preview: (args_0: Readonly<{} & { timeRange: string; alertParams: Readonly<{} & { severity: number; jobSelection: Readonly<{} & { groupIds: string[]; jobIds: string[]; }>; resultType: \"bucket\" | \"record\" | \"influencer\"; includeInterim: boolean; lookbackInterval: string | null; topNBuckets: number | null; }>; sampleSize: number; }>) => Promise; execute: (params: Readonly<{} & { severity: number; jobSelection: Readonly<{} & { groupIds: string[]; jobIds: string[]; }>; resultType: \"bucket\" | \"record\" | \"influencer\"; includeInterim: boolean; lookbackInterval: string | null; topNBuckets: number | null; }>) => Promise<{ context: ", "AnomalyDetectionAlertContext", "; name: string; isHealthy: boolean; } | undefined>; }; }" diff --git a/api_docs/ml.mdx b/api_docs/ml.mdx index 9325f014abee2..7cf5e6f08934f 100644 --- a/api_docs/ml.mdx +++ b/api_docs/ml.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/ml title: "ml" image: https://source.unsplash.com/400x175/?github summary: API docs for the ml plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ml'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/monitoring.mdx b/api_docs/monitoring.mdx index 6d4c8820331c0..9a96f5fb71459 100644 --- a/api_docs/monitoring.mdx +++ b/api_docs/monitoring.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/monitoring title: "monitoring" image: https://source.unsplash.com/400x175/?github summary: API docs for the monitoring plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'monitoring'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/monitoring_collection.mdx b/api_docs/monitoring_collection.mdx index b7bb575168740..dd904b036cb13 100644 --- a/api_docs/monitoring_collection.mdx +++ b/api_docs/monitoring_collection.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/monitoringCollection title: "monitoringCollection" image: https://source.unsplash.com/400x175/?github summary: API docs for the monitoringCollection plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'monitoringCollection'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/navigation.mdx b/api_docs/navigation.mdx index 2c1488cb349f8..c34729aae4333 100644 --- a/api_docs/navigation.mdx +++ b/api_docs/navigation.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/navigation title: "navigation" image: https://source.unsplash.com/400x175/?github summary: API docs for the navigation plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'navigation'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/newsfeed.mdx b/api_docs/newsfeed.mdx index 393daf44003d0..9fd49bf331ce3 100644 --- a/api_docs/newsfeed.mdx +++ b/api_docs/newsfeed.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/newsfeed title: "newsfeed" image: https://source.unsplash.com/400x175/?github summary: API docs for the newsfeed plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'newsfeed'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/observability.devdocs.json b/api_docs/observability.devdocs.json index 3bcd908b14782..b7ed67de04c43 100644 --- a/api_docs/observability.devdocs.json +++ b/api_docs/observability.devdocs.json @@ -2069,6 +2069,20 @@ "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/embeddable/embeddable.tsx", "deprecated": false }, + { + "parentPluginId": "observability", + "id": "def-public.ExploratoryEmbeddableProps.legendPosition", + "type": "CompoundType", + "tags": [], + "label": "legendPosition", + "description": [], + "signature": [ + "Position", + " | undefined" + ], + "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/embeddable/embeddable.tsx", + "deprecated": false + }, { "parentPluginId": "observability", "id": "def-public.ExploratoryEmbeddableProps.onBrushEnd", @@ -2204,6 +2218,19 @@ ], "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/embeddable/embeddable.tsx", "deprecated": false + }, + { + "parentPluginId": "observability", + "id": "def-public.ExploratoryEmbeddableProps.align", + "type": "CompoundType", + "tags": [], + "label": "align", + "description": [], + "signature": [ + "\"left\" | \"right\" | \"center\" | undefined" + ], + "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/embeddable/embeddable.tsx", + "deprecated": false } ], "initialIsOpen": false @@ -6535,13 +6562,7 @@ "text": "RequestStatus" }, "; esResponse: any; kibanaRequest: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "; operationName: string; startTime: number; }) => ", { "pluginId": "inspector", @@ -6631,13 +6652,7 @@ "label": "kibanaRequest", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/observability/common/utils/get_inspect_response.ts", @@ -6982,13 +6997,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/observability/server/routes/types.ts", @@ -7249,13 +7258,7 @@ "text": "LicensingApiRequestHandlerContext" }, ">; }, request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => Promise<{ readonly index: string; create: (createParams: { annotation: { type: string; }; '@timestamp': string; message: string; } & { tags?: string[] | undefined; service?: { name?: string | undefined; environment?: string | undefined; version?: string | undefined; } | undefined; }) => Promise<{ _id: string; _index: string; _source: ", "Annotation", "; }>; getById: (getByIdParams: { id: string; }) => Promise<", diff --git a/api_docs/observability.mdx b/api_docs/observability.mdx index 3ebe6d5b9c829..71cfee396b9d1 100644 --- a/api_docs/observability.mdx +++ b/api_docs/observability.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/observability title: "observability" image: https://source.unsplash.com/400x175/?github summary: API docs for the observability plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'observability'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Observability UI](https://github.com/orgs/elastic/teams/observability-u | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 384 | 2 | 381 | 31 | +| 386 | 2 | 383 | 31 | ## Client diff --git a/api_docs/osquery.mdx b/api_docs/osquery.mdx index 3a13dfad6c840..52aac69572b83 100644 --- a/api_docs/osquery.mdx +++ b/api_docs/osquery.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/osquery title: "osquery" image: https://source.unsplash.com/400x175/?github summary: API docs for the osquery plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'osquery'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/plugin_directory.mdx b/api_docs/plugin_directory.mdx index f7ed0b2b7a9c4..80e714e48ffa2 100644 --- a/api_docs/plugin_directory.mdx +++ b/api_docs/plugin_directory.mdx @@ -3,7 +3,7 @@ id: kibDevDocsPluginDirectory slug: /kibana-dev-docs/api-meta/plugin-api-directory title: Directory summary: Directory of public APIs available through plugins or packages. -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -12,13 +12,13 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Count | Plugins or Packages with a
public API | Number of teams | |--------------|----------|------------------------| -| 324 | 266 | 36 | +| 335 | 276 | 36 | ### Public API health stats | API Count | Any Count | Missing comments | Missing exports | |--------------|----------|-----------------|--------| -| 26847 | 172 | 19400 | 1322 | +| 27414 | 172 | 19519 | 1433 | ## Plugin Directory @@ -38,9 +38,9 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Cloud Security Posture](https://github.com/orgs/elastic/teams/cloud-posture-security) | The cloud security posture plugin | 6 | 0 | 6 | 0 | | | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 13 | 0 | 13 | 1 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | The Controls Plugin contains embeddable components intended to create a simple query interface for end users, and a powerful editing suite that allows dashboard authors to build controls | 206 | 0 | 198 | 7 | -| | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 2506 | 14 | 887 | 27 | +| | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 2489 | 9 | 746 | 25 | | crossClusterReplication | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 | -| | [Fleet](https://github.com/orgs/elastic/teams/fleet) | Add custom data integrations so they can be displayed in the Fleet integrations app | 101 | 0 | 82 | 1 | +| | [Fleet](https://github.com/orgs/elastic/teams/fleet) | Add custom data integrations so they can be displayed in the Fleet integrations app | 102 | 0 | 83 | 1 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds the Dashboard app to Kibana | 143 | 0 | 141 | 12 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 52 | 0 | 51 | 0 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters. | 3075 | 34 | 2402 | 21 | @@ -52,10 +52,10 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 10 | 0 | 8 | 2 | | | [Data Discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | This plugin contains the Discover application and the saved search embeddable. | 79 | 0 | 63 | 7 | | | [Data Discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | - | 37 | 0 | 35 | 2 | -| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds embeddables service to Kibana | 494 | 0 | 403 | 3 | +| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds embeddables service to Kibana | 505 | 0 | 413 | 3 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Extends embeddable plugin with more functionality | 14 | 0 | 14 | 0 | | | [Platform Security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides encryption and decryption utilities for saved objects containing sensitive information. | 51 | 0 | 44 | 0 | -| | [Enterprise Search](https://github.com/orgs/elastic/teams/enterprise-search-frontend) | Adds dashboards for discovering and managing Enterprise Search products. | 3 | 0 | 3 | 0 | +| | [Enterprise Search](https://github.com/orgs/elastic/teams/enterprise-search-frontend) | Adds dashboards for discovering and managing Enterprise Search products. | 5 | 0 | 5 | 0 | | | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 114 | 3 | 110 | 3 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | The Event Annotation service contains expressions for event annotations | 90 | 0 | 90 | 5 | | | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 100 | 0 | 100 | 9 | @@ -76,7 +76,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 222 | 0 | 95 | 2 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Index pattern fields and ambiguous values formatters | 288 | 5 | 249 | 3 | | | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | The file upload plugin contains components and services for uploading a file, analyzing its data, and then importing the data into an Elasticsearch index. Supported file types include CSV, TSV, newline-delimited JSON and GeoJSON. | 62 | 0 | 62 | 2 | -| | [Fleet](https://github.com/orgs/elastic/teams/fleet) | - | 1521 | 8 | 1389 | 10 | +| | [Fleet](https://github.com/orgs/elastic/teams/fleet) | - | 1522 | 8 | 1390 | 10 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 68 | 0 | 14 | 5 | | globalSearchBar | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 0 | 0 | 0 | 0 | | globalSearchProviders | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 0 | 0 | 0 | 0 | @@ -95,21 +95,21 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | kibanaUsageCollection | [Kibana Telemetry](https://github.com/orgs/elastic/teams/kibana-telemetry) | - | 0 | 0 | 0 | 0 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 615 | 3 | 420 | 9 | | | [Security Team](https://github.com/orgs/elastic/teams/security-team) | - | 3 | 0 | 3 | 1 | -| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Visualization editor allowing to quickly and easily configure compelling visualizations to use on dashboards and canvas workpads. Exposes components to embed visualizations and link into the Lens editor from within other apps in Kibana. | 600 | 0 | 522 | 40 | +| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Visualization editor allowing to quickly and easily configure compelling visualizations to use on dashboards and canvas workpads. Exposes components to embed visualizations and link into the Lens editor from within other apps in Kibana. | 601 | 0 | 523 | 40 | | | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 8 | 0 | 8 | 0 | | | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 3 | 0 | 3 | 0 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 117 | 0 | 42 | 10 | | | [Security detections response](https://github.com/orgs/elastic/teams/security-detections-response) | - | 198 | 0 | 90 | 49 | | logstash | [Logstash](https://github.com/orgs/elastic/teams/logstash) | - | 0 | 0 | 0 | 0 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | - | 41 | 0 | 41 | 6 | -| | [GIS](https://github.com/orgs/elastic/teams/kibana-gis) | - | 248 | 0 | 247 | 24 | +| | [GIS](https://github.com/orgs/elastic/teams/kibana-gis) | - | 249 | 0 | 248 | 24 | | | [GIS](https://github.com/orgs/elastic/teams/kibana-gis) | - | 67 | 0 | 67 | 0 | | | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | This plugin provides access to the machine learning features provided by Elastic. | 251 | 10 | 78 | 31 | | | [Stack Monitoring](https://github.com/orgs/elastic/teams/stack-monitoring-ui) | - | 11 | 0 | 9 | 1 | | | [Stack Monitoring](https://github.com/orgs/elastic/teams/stack-monitoring-ui) | - | 9 | 0 | 9 | 0 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 34 | 0 | 34 | 2 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 17 | 0 | 17 | 0 | -| | [Observability UI](https://github.com/orgs/elastic/teams/observability-ui) | - | 384 | 2 | 381 | 31 | +| | [Observability UI](https://github.com/orgs/elastic/teams/observability-ui) | - | 386 | 2 | 383 | 31 | | | [Security asset management](https://github.com/orgs/elastic/teams/security-asset-management) | - | 13 | 0 | 13 | 0 | | painlessLab | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | The Presentation Utility Plugin is a set of common, shared components and toolkits for solutions within the Presentation space, (e.g. Dashboards, Canvas). | 231 | 2 | 180 | 11 | @@ -134,7 +134,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Platform Security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides the Spaces feature, which allows saved objects to be organized into meaningful categories. | 260 | 0 | 64 | 0 | | | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 4 | 0 | 4 | 0 | | synthetics | [Uptime](https://github.com/orgs/elastic/teams/uptime) | This plugin visualizes data from Synthetics and Heartbeat, and integrates with other Observability solutions. | 0 | 0 | 0 | 0 | -| | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 80 | 0 | 39 | 7 | +| | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 82 | 0 | 41 | 7 | | | [Kibana Telemetry](https://github.com/orgs/elastic/teams/kibana-telemetry) | - | 43 | 0 | 1 | 0 | | | [Kibana Telemetry](https://github.com/orgs/elastic/teams/kibana-telemetry) | - | 32 | 0 | 32 | 6 | | | [Kibana Telemetry](https://github.com/orgs/elastic/teams/kibana-telemetry) | - | 1 | 0 | 1 | 0 | @@ -221,6 +221,11 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Owner missing] | - | 5 | 0 | 5 | 0 | | | [Owner missing] | - | 9 | 0 | 2 | 0 | | | [Owner missing] | - | 4 | 0 | 4 | 0 | +| | [Owner missing] | - | 111 | 4 | 37 | 0 | +| | [Owner missing] | - | 10 | 0 | 10 | 0 | +| | [Owner missing] | - | 16 | 0 | 16 | 0 | +| | [Owner missing] | - | 4 | 0 | 0 | 0 | +| | [Owner missing] | - | 392 | 1 | 154 | 0 | | | [Owner missing] | - | 4 | 0 | 2 | 0 | | | [Owner missing] | - | 3 | 0 | 3 | 0 | | | [Owner missing] | - | 8 | 2 | 6 | 0 | @@ -231,10 +236,13 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Owner missing] | - | 5 | 0 | 0 | 0 | | | [Owner missing] | - | 3 | 0 | 3 | 0 | | | [Owner missing] | - | 3 | 0 | 3 | 0 | +| | [Owner missing] | - | 5 | 0 | 0 | 0 | +| | [Owner missing] | - | 6 | 0 | 6 | 0 | | | [Owner missing] | - | 6 | 0 | 4 | 0 | | | [Owner missing] | - | 2 | 0 | 1 | 0 | | | [Owner missing] | - | 6 | 0 | 6 | 0 | | | [Owner missing] | - | 13 | 0 | 7 | 0 | +| | [Owner missing] | - | 10 | 0 | 10 | 0 | | | [Owner missing] | elasticsearch datemath parser, used in kibana | 44 | 0 | 43 | 0 | | | [Owner missing] | - | 9 | 1 | 9 | 0 | | | [Owner missing] | - | 65 | 0 | 64 | 0 | @@ -250,6 +258,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Owner missing] | - | 2 | 0 | 0 | 0 | | | [Owner missing] | - | 1 | 0 | 0 | 0 | | | [Owner missing] | - | 6 | 0 | 0 | 0 | +| | [Owner missing] | - | 3 | 0 | 3 | 0 | | | [Owner missing] | - | 10 | 0 | 4 | 2 | | | [Owner missing] | - | 51 | 0 | 48 | 0 | | | [Owner missing] | - | 43 | 0 | 36 | 0 | @@ -292,9 +301,10 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Owner missing] | - | 25 | 0 | 24 | 1 | | | [Owner missing] | - | 20 | 0 | 6 | 0 | | | [Owner missing] | - | 15 | 0 | 8 | 1 | -| | [Owner missing] | - | 13 | 0 | 7 | 1 | +| | [Owner missing] | - | 11 | 0 | 6 | 0 | | | [Owner missing] | - | 12 | 0 | 8 | 5 | | | [Owner missing] | - | 31 | 0 | 12 | 2 | +| | [Owner missing] | - | 5 | 0 | 3 | 0 | | | [Owner missing] | - | 22 | 0 | 13 | 2 | | | [Owner missing] | - | 80 | 0 | 51 | 1 | | | [Owner missing] | - | 16 | 0 | 7 | 0 | @@ -311,7 +321,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Owner missing] | - | 113 | 1 | 65 | 0 | | | [Owner missing] | - | 83 | 0 | 83 | 1 | | | [Owner missing] | - | 7 | 0 | 6 | 0 | -| | [Owner missing] | - | 29 | 0 | 10 | 1 | +| | [Owner missing] | - | 32 | 0 | 12 | 1 | | | [Owner missing] | - | 2 | 0 | 2 | 0 | | | [Owner missing] | - | 31 | 1 | 21 | 0 | diff --git a/api_docs/presentation_util.mdx b/api_docs/presentation_util.mdx index f250fddea5611..c7b08aab4bd73 100644 --- a/api_docs/presentation_util.mdx +++ b/api_docs/presentation_util.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/presentationUtil title: "presentationUtil" image: https://source.unsplash.com/400x175/?github summary: API docs for the presentationUtil plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'presentationUtil'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/remote_clusters.mdx b/api_docs/remote_clusters.mdx index 3c8bb3dea29b8..59c7c219a1602 100644 --- a/api_docs/remote_clusters.mdx +++ b/api_docs/remote_clusters.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/remoteClusters title: "remoteClusters" image: https://source.unsplash.com/400x175/?github summary: API docs for the remoteClusters plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'remoteClusters'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/reporting.mdx b/api_docs/reporting.mdx index 190c648de0d92..8d73fbaa1f36a 100644 --- a/api_docs/reporting.mdx +++ b/api_docs/reporting.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/reporting title: "reporting" image: https://source.unsplash.com/400x175/?github summary: API docs for the reporting plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'reporting'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/rollup.mdx b/api_docs/rollup.mdx index 41c84a2b7d638..deb418b833fe3 100644 --- a/api_docs/rollup.mdx +++ b/api_docs/rollup.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/rollup title: "rollup" image: https://source.unsplash.com/400x175/?github summary: API docs for the rollup plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'rollup'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/rule_registry.devdocs.json b/api_docs/rule_registry.devdocs.json index 6a24504926bfd..26e35c8109a04 100644 --- a/api_docs/rule_registry.devdocs.json +++ b/api_docs/rule_registry.devdocs.json @@ -3549,13 +3549,7 @@ "description": [], "signature": [ "(req: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => Promise<", { "pluginId": "ruleRegistry", @@ -3577,13 +3571,7 @@ "label": "req", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/rule_registry/server/plugin.ts", diff --git a/api_docs/rule_registry.mdx b/api_docs/rule_registry.mdx index 92b769fab3bba..db25b33fb89f9 100644 --- a/api_docs/rule_registry.mdx +++ b/api_docs/rule_registry.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/ruleRegistry title: "ruleRegistry" image: https://source.unsplash.com/400x175/?github summary: API docs for the ruleRegistry plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ruleRegistry'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/runtime_fields.mdx b/api_docs/runtime_fields.mdx index 1b2c01b149e1e..e0a004928b4b2 100644 --- a/api_docs/runtime_fields.mdx +++ b/api_docs/runtime_fields.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/runtimeFields title: "runtimeFields" image: https://source.unsplash.com/400x175/?github summary: API docs for the runtimeFields plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'runtimeFields'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/saved_objects.mdx b/api_docs/saved_objects.mdx index db943e605387b..2792e2107d074 100644 --- a/api_docs/saved_objects.mdx +++ b/api_docs/saved_objects.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/savedObjects title: "savedObjects" image: https://source.unsplash.com/400x175/?github summary: API docs for the savedObjects plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjects'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/saved_objects_management.mdx b/api_docs/saved_objects_management.mdx index 592136b206dd6..4d25d3bf28f50 100644 --- a/api_docs/saved_objects_management.mdx +++ b/api_docs/saved_objects_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/savedObjectsManagement title: "savedObjectsManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the savedObjectsManagement plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/saved_objects_tagging.mdx b/api_docs/saved_objects_tagging.mdx index 84e2121b2d2c7..5b61e650b0976 100644 --- a/api_docs/saved_objects_tagging.mdx +++ b/api_docs/saved_objects_tagging.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/savedObjectsTagging title: "savedObjectsTagging" image: https://source.unsplash.com/400x175/?github summary: API docs for the savedObjectsTagging plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsTagging'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/saved_objects_tagging_oss.mdx b/api_docs/saved_objects_tagging_oss.mdx index 045d2b4b6473c..8f7e57b1e2718 100644 --- a/api_docs/saved_objects_tagging_oss.mdx +++ b/api_docs/saved_objects_tagging_oss.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/savedObjectsTaggingOss title: "savedObjectsTaggingOss" image: https://source.unsplash.com/400x175/?github summary: API docs for the savedObjectsTaggingOss plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsTaggingOss'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/screenshot_mode.devdocs.json b/api_docs/screenshot_mode.devdocs.json index fead68be2cb62..a988c4737f06b 100644 --- a/api_docs/screenshot_mode.devdocs.json +++ b/api_docs/screenshot_mode.devdocs.json @@ -266,13 +266,7 @@ ], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => boolean" ], "path": "src/plugins/screenshot_mode/server/types.ts", @@ -286,13 +280,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "src/plugins/screenshot_mode/server/types.ts", diff --git a/api_docs/screenshot_mode.mdx b/api_docs/screenshot_mode.mdx index 06aa991f1e6b0..7b042ea1f93c6 100644 --- a/api_docs/screenshot_mode.mdx +++ b/api_docs/screenshot_mode.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/screenshotMode title: "screenshotMode" image: https://source.unsplash.com/400x175/?github summary: API docs for the screenshotMode plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'screenshotMode'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/screenshotting.mdx b/api_docs/screenshotting.mdx index d267438f40e3c..51a7e1a61919f 100644 --- a/api_docs/screenshotting.mdx +++ b/api_docs/screenshotting.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/screenshotting title: "screenshotting" image: https://source.unsplash.com/400x175/?github summary: API docs for the screenshotting plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'screenshotting'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/security.devdocs.json b/api_docs/security.devdocs.json index f3a6e067bb09a..17da37f5902c4 100644 --- a/api_docs/security.devdocs.json +++ b/api_docs/security.devdocs.json @@ -1044,13 +1044,7 @@ ], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", { "pluginId": "security", @@ -1071,13 +1065,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/security/server/audit/audit_service.ts", @@ -1251,13 +1239,7 @@ "description": [], "signature": [ "{ create: (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ", createParams: ", { "pluginId": "security", @@ -1275,13 +1257,7 @@ "text": "CreateAPIKeyResult" }, " | null>; areAPIKeysEnabled: () => Promise; invalidate: (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ", params: ", { "pluginId": "security", @@ -1299,13 +1275,7 @@ "text": "InvalidateAPIKeyResult" }, " | null>; grantAsInternalUser: (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ", createParams: ", { "pluginId": "security", @@ -1352,13 +1322,7 @@ "description": [], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", { "pluginId": "security", @@ -1380,13 +1344,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/security/server/authentication/authentication_service.ts", @@ -1738,13 +1696,7 @@ "description": [], "signature": [ "{ getCurrentUser: (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", { "pluginId": "security", diff --git a/api_docs/security.mdx b/api_docs/security.mdx index 6ff69b8e2d064..434d136388f5e 100644 --- a/api_docs/security.mdx +++ b/api_docs/security.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/security title: "security" image: https://source.unsplash.com/400x175/?github summary: API docs for the security plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'security'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/security_solution.devdocs.json b/api_docs/security_solution.devdocs.json index fb3cb3c38c48e..9146fb540b3cc 100644 --- a/api_docs/security_solution.devdocs.json +++ b/api_docs/security_solution.devdocs.json @@ -964,13 +964,7 @@ "description": [], "signature": [ "(req: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", "EndpointScopedFleetServicesInterface" ], @@ -985,13 +979,7 @@ "label": "req", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/security_solution/server/types.ts", diff --git a/api_docs/security_solution.mdx b/api_docs/security_solution.mdx index c0c9e8e1f19e6..d1d77eae3d5fc 100644 --- a/api_docs/security_solution.mdx +++ b/api_docs/security_solution.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/securitySolution title: "securitySolution" image: https://source.unsplash.com/400x175/?github summary: API docs for the securitySolution plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'securitySolution'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/session_view.mdx b/api_docs/session_view.mdx index 83d32cbf1a6d1..da2c2cf09a878 100644 --- a/api_docs/session_view.mdx +++ b/api_docs/session_view.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/sessionView title: "sessionView" image: https://source.unsplash.com/400x175/?github summary: API docs for the sessionView plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'sessionView'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/share.mdx b/api_docs/share.mdx index 56c6b2c598eae..b6a02d17aecc4 100644 --- a/api_docs/share.mdx +++ b/api_docs/share.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/share title: "share" image: https://source.unsplash.com/400x175/?github summary: API docs for the share plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'share'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/shared_u_x.mdx b/api_docs/shared_u_x.mdx index 9fee98f17877a..de326e69e0fe2 100644 --- a/api_docs/shared_u_x.mdx +++ b/api_docs/shared_u_x.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/sharedUX title: "sharedUX" image: https://source.unsplash.com/400x175/?github summary: API docs for the sharedUX plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'sharedUX'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/snapshot_restore.mdx b/api_docs/snapshot_restore.mdx index 83714e031702e..2d533df972c65 100644 --- a/api_docs/snapshot_restore.mdx +++ b/api_docs/snapshot_restore.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/snapshotRestore title: "snapshotRestore" image: https://source.unsplash.com/400x175/?github summary: API docs for the snapshotRestore plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'snapshotRestore'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/spaces.devdocs.json b/api_docs/spaces.devdocs.json index 24c3e5c55aeec..0010e6bbdd17a 100644 --- a/api_docs/spaces.devdocs.json +++ b/api_docs/spaces.devdocs.json @@ -33,13 +33,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "x-pack/plugins/spaces/public/spaces_manager/spaces_manager.ts", "deprecated": false, @@ -3533,13 +3527,7 @@ ], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => string" ], "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts", @@ -3555,13 +3543,7 @@ "the request." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts", @@ -3665,13 +3647,7 @@ ], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", { "pluginId": "spaces", @@ -3694,13 +3670,7 @@ "the request." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts", @@ -3721,13 +3691,7 @@ ], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => string" ], "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts", @@ -3743,13 +3707,7 @@ "the request." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts", @@ -3770,13 +3728,7 @@ ], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => boolean" ], "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts", @@ -3792,13 +3744,7 @@ "the request." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts", @@ -3819,13 +3765,7 @@ ], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => Promise<", { "pluginId": "spaces", @@ -3849,13 +3789,7 @@ "the request." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts", @@ -3968,13 +3902,7 @@ ], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ", savedObjectsStart: ", { "pluginId": "core", @@ -4004,13 +3932,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/spaces/server/spaces_client/spaces_client_service.ts", @@ -4051,13 +3973,7 @@ ], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ", baseClient: ", { "pluginId": "spaces", @@ -4087,13 +4003,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/spaces/server/spaces_client/spaces_client_service.ts", diff --git a/api_docs/spaces.mdx b/api_docs/spaces.mdx index 90c78cd0a3624..2082447ea3258 100644 --- a/api_docs/spaces.mdx +++ b/api_docs/spaces.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/spaces title: "spaces" image: https://source.unsplash.com/400x175/?github summary: API docs for the spaces plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'spaces'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/stack_alerts.mdx b/api_docs/stack_alerts.mdx index 4b923239549c5..e5cce413d231b 100644 --- a/api_docs/stack_alerts.mdx +++ b/api_docs/stack_alerts.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/stackAlerts title: "stackAlerts" image: https://source.unsplash.com/400x175/?github summary: API docs for the stackAlerts plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'stackAlerts'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/task_manager.devdocs.json b/api_docs/task_manager.devdocs.json index 9b015ce7264be..49c9fd818c3dd 100644 --- a/api_docs/task_manager.devdocs.json +++ b/api_docs/task_manager.devdocs.json @@ -239,6 +239,43 @@ } ], "functions": [ + { + "parentPluginId": "taskManager", + "id": "def-server.aggregateTaskOverduePercentilesForType", + "type": "Function", + "tags": [], + "label": "aggregateTaskOverduePercentilesForType", + "description": [], + "signature": [ + "(type: string) => { aggs: Record; query: ", + "QueryDslQueryContainer", + "; runtime_mappings: ", + "MappingRuntimeFields", + "; }" + ], + "path": "x-pack/plugins/task_manager/server/queries/aggregate_task_overdue_percentiles_for_type.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "taskManager", + "id": "def-server.aggregateTaskOverduePercentilesForType.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/task_manager/server/queries/aggregate_task_overdue_percentiles_for_type.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "taskManager", "id": "def-server.asInterval", @@ -1400,7 +1437,7 @@ "TaskScheduling", ", \"schedule\" | \"runSoon\" | \"ephemeralRunNow\" | \"ensureScheduled\" | \"bulkUpdateSchedules\"> & Pick<", "TaskStore", - ", \"fetch\" | \"get\" | \"remove\"> & { removeIfExists: (id: string) => Promise; } & { supportsEphemeralTasks: () => boolean; }" + ", \"aggregate\" | \"fetch\" | \"get\" | \"remove\"> & { removeIfExists: (id: string) => Promise; } & { supportsEphemeralTasks: () => boolean; }" ], "path": "x-pack/plugins/task_manager/server/plugin.ts", "deprecated": false, diff --git a/api_docs/task_manager.mdx b/api_docs/task_manager.mdx index c45d79117db50..2ca6c69bacca9 100644 --- a/api_docs/task_manager.mdx +++ b/api_docs/task_manager.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/taskManager title: "taskManager" image: https://source.unsplash.com/400x175/?github summary: API docs for the taskManager plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'taskManager'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Response Ops](https://github.com/orgs/elastic/teams/response-ops) for q | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 80 | 0 | 39 | 7 | +| 82 | 0 | 41 | 7 | ## Server diff --git a/api_docs/telemetry.mdx b/api_docs/telemetry.mdx index 39058e437a4da..b0a927943f987 100644 --- a/api_docs/telemetry.mdx +++ b/api_docs/telemetry.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/telemetry title: "telemetry" image: https://source.unsplash.com/400x175/?github summary: API docs for the telemetry plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetry'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/telemetry_collection_manager.mdx b/api_docs/telemetry_collection_manager.mdx index 0eaab1a600677..5ed1647e3fd4e 100644 --- a/api_docs/telemetry_collection_manager.mdx +++ b/api_docs/telemetry_collection_manager.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/telemetryCollectionManager title: "telemetryCollectionManager" image: https://source.unsplash.com/400x175/?github summary: API docs for the telemetryCollectionManager plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryCollectionManager'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/telemetry_collection_xpack.mdx b/api_docs/telemetry_collection_xpack.mdx index e4b22d239ecd6..421ef5b38c9a8 100644 --- a/api_docs/telemetry_collection_xpack.mdx +++ b/api_docs/telemetry_collection_xpack.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/telemetryCollectionXpack title: "telemetryCollectionXpack" image: https://source.unsplash.com/400x175/?github summary: API docs for the telemetryCollectionXpack plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryCollectionXpack'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/telemetry_management_section.mdx b/api_docs/telemetry_management_section.mdx index c7259bfd0abde..3d33d343a8620 100644 --- a/api_docs/telemetry_management_section.mdx +++ b/api_docs/telemetry_management_section.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/telemetryManagementSection title: "telemetryManagementSection" image: https://source.unsplash.com/400x175/?github summary: API docs for the telemetryManagementSection plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryManagementSection'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/timelines.devdocs.json b/api_docs/timelines.devdocs.json index 38c0c9653f999..1ef3a094339f2 100644 --- a/api_docs/timelines.devdocs.json +++ b/api_docs/timelines.devdocs.json @@ -6968,9 +6968,7 @@ }, "; filterQuery: string | ", "ESQuery", - " | undefined; docValueFields?: ", - "QueryDslFieldAndFormat", - "[] | undefined; factoryQueryType?: ", + " | undefined; factoryQueryType?: ", "TimelineEventsQueries", " | undefined; entityType?: ", { diff --git a/api_docs/timelines.mdx b/api_docs/timelines.mdx index 42cbbca2ad90f..c384f9da142fc 100644 --- a/api_docs/timelines.mdx +++ b/api_docs/timelines.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/timelines title: "timelines" image: https://source.unsplash.com/400x175/?github summary: API docs for the timelines plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'timelines'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/transform.mdx b/api_docs/transform.mdx index cd5be8ee1ab9a..a8e0315881b2d 100644 --- a/api_docs/transform.mdx +++ b/api_docs/transform.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/transform title: "transform" image: https://source.unsplash.com/400x175/?github summary: API docs for the transform plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'transform'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/triggers_actions_ui.devdocs.json b/api_docs/triggers_actions_ui.devdocs.json index af719d437a2d1..21cdbb34c1e45 100644 --- a/api_docs/triggers_actions_ui.devdocs.json +++ b/api_docs/triggers_actions_ui.devdocs.json @@ -353,13 +353,7 @@ "description": [], "signature": [ "({\n ids,\n http,\n}: { ids: string[]; http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", "; }) => Promise<{ successes: string[]; errors: string[]; }>" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/delete.ts", @@ -396,13 +390,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/delete.ts", "deprecated": false @@ -422,13 +410,7 @@ "description": [], "signature": [ "({ id, http }: { id: string; http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", "; }) => Promise" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/disable.ts", @@ -462,13 +444,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/disable.ts", "deprecated": false @@ -520,13 +496,7 @@ "description": [], "signature": [ "({ id, http }: { id: string; http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", "; }) => Promise" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/enable.ts", @@ -560,13 +530,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/enable.ts", "deprecated": false @@ -618,13 +582,7 @@ "description": [], "signature": [ "(http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", ", indexes: string[]) => Promise<{ name: string; type: string; normalizedType: string; searchable: boolean; aggregatable: boolean; }[]>" ], "path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts", @@ -638,13 +596,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts", "deprecated": false, @@ -677,13 +629,7 @@ "description": [], "signature": [ "(http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", ", pattern: string) => Promise<", "IOption", "[]>" @@ -699,13 +645,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts", "deprecated": false, @@ -878,13 +818,7 @@ "description": [], "signature": [ "({ http }: { http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", "; }) => Promise<", { "pluginId": "actions", @@ -916,13 +850,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/action_connector_api/connector_types.ts", "deprecated": false @@ -942,13 +870,7 @@ "description": [], "signature": [ "({ http }: { http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", "; }) => Promise<", { "pluginId": "triggersActionsUi", @@ -980,13 +902,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/action_connector_api/connectors.ts", "deprecated": false @@ -1008,13 +924,7 @@ "({ id, http, dateStart, dateEnd, filter, perPage, page, sort, }: ", "LoadExecutionLogAggregationsProps", " & { http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", "; }) => Promise<", { "pluginId": "alerting", @@ -1038,13 +948,7 @@ "signature": [ "LoadExecutionLogAggregationsProps", " & { http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", "; }" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/load_execution_log_aggregations.ts", @@ -1064,13 +968,7 @@ "description": [], "signature": [ "({\n http,\n ruleId,\n}: { http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", "; ruleId: string; }) => Promise<", { "pluginId": "triggersActionsUi", @@ -1110,13 +1008,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/get_rule.ts", "deprecated": false @@ -1230,13 +1122,7 @@ "description": [], "signature": [ "({\n http,\n ruleId,\n numberOfExecutions,\n}: { http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", "; ruleId: string; numberOfExecutions?: number | undefined; }) => Promise<", { "pluginId": "alerting", @@ -1268,13 +1154,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/rule_summary.ts", "deprecated": false @@ -1317,13 +1197,7 @@ "description": [], "signature": [ "({ http }: { http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", "; }) => Promise<", "RuleTagsAggregations", ">" @@ -1349,13 +1223,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/aggregate.ts", "deprecated": false @@ -1375,13 +1243,7 @@ "description": [], "signature": [ "({ http }: { http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", "; }) => Promise<", { "pluginId": "triggersActionsUi", @@ -1413,13 +1275,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/rule_types.ts", "deprecated": false @@ -1439,13 +1295,7 @@ "description": [], "signature": [ "({ id, http }: { id: string; http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", "; }) => Promise" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/mute.ts", @@ -1479,13 +1329,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/mute.ts", "deprecated": false @@ -1539,13 +1383,7 @@ "({\n id,\n snoozeSchedule,\n http,\n}: { id: string; snoozeSchedule: ", "SnoozeSchedule", "; http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", "; }) => Promise" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/snooze.ts", @@ -1592,13 +1430,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/snooze.ts", "deprecated": false @@ -1695,13 +1527,7 @@ "description": [], "signature": [ "({ id, http }: { id: string; http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", "; }) => Promise" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unmute.ts", @@ -1735,13 +1561,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unmute.ts", "deprecated": false @@ -1761,13 +1581,7 @@ "description": [], "signature": [ "({\n id,\n http,\n scheduleIds,\n}: { id: string; http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", "; scheduleIds?: string[] | undefined; }) => Promise" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unsnooze.ts", @@ -1801,13 +1615,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unsnooze.ts", "deprecated": false diff --git a/api_docs/triggers_actions_ui.mdx b/api_docs/triggers_actions_ui.mdx index a782d4581e29f..c5522864a1c75 100644 --- a/api_docs/triggers_actions_ui.mdx +++ b/api_docs/triggers_actions_ui.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/triggersActionsUi title: "triggersActionsUi" image: https://source.unsplash.com/400x175/?github summary: API docs for the triggersActionsUi plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'triggersActionsUi'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/ui_actions.mdx b/api_docs/ui_actions.mdx index 598a870631ace..49db9908f5e09 100644 --- a/api_docs/ui_actions.mdx +++ b/api_docs/ui_actions.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/uiActions title: "uiActions" image: https://source.unsplash.com/400x175/?github summary: API docs for the uiActions plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'uiActions'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/ui_actions_enhanced.mdx b/api_docs/ui_actions_enhanced.mdx index 0c51c3092f2dc..176c8a902aa9c 100644 --- a/api_docs/ui_actions_enhanced.mdx +++ b/api_docs/ui_actions_enhanced.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/uiActionsEnhanced title: "uiActionsEnhanced" image: https://source.unsplash.com/400x175/?github summary: API docs for the uiActionsEnhanced plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'uiActionsEnhanced'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/unified_search.mdx b/api_docs/unified_search.mdx index 1ee7ab0db84ce..31a4820f9da14 100644 --- a/api_docs/unified_search.mdx +++ b/api_docs/unified_search.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/unifiedSearch title: "unifiedSearch" image: https://source.unsplash.com/400x175/?github summary: API docs for the unifiedSearch plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedSearch'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/unified_search_autocomplete.mdx b/api_docs/unified_search_autocomplete.mdx index a4496a610e468..40f91935ccaeb 100644 --- a/api_docs/unified_search_autocomplete.mdx +++ b/api_docs/unified_search_autocomplete.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/unifiedSearch-autocomplete title: "unifiedSearch.autocomplete" image: https://source.unsplash.com/400x175/?github summary: API docs for the unifiedSearch.autocomplete plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedSearch.autocomplete'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/url_forwarding.mdx b/api_docs/url_forwarding.mdx index 052deae9d8054..257045a1a7cd8 100644 --- a/api_docs/url_forwarding.mdx +++ b/api_docs/url_forwarding.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/urlForwarding title: "urlForwarding" image: https://source.unsplash.com/400x175/?github summary: API docs for the urlForwarding plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'urlForwarding'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/usage_collection.mdx b/api_docs/usage_collection.mdx index c57196aab0504..68a4cf6640fa6 100644 --- a/api_docs/usage_collection.mdx +++ b/api_docs/usage_collection.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/usageCollection title: "usageCollection" image: https://source.unsplash.com/400x175/?github summary: API docs for the usageCollection plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'usageCollection'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/ux.mdx b/api_docs/ux.mdx index f9ded6a7f35a8..c59920507b2c0 100644 --- a/api_docs/ux.mdx +++ b/api_docs/ux.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/ux title: "ux" image: https://source.unsplash.com/400x175/?github summary: API docs for the ux plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ux'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_default_editor.mdx b/api_docs/vis_default_editor.mdx index ad8aa52f4a2c6..643412cbea7b5 100644 --- a/api_docs/vis_default_editor.mdx +++ b/api_docs/vis_default_editor.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visDefaultEditor title: "visDefaultEditor" image: https://source.unsplash.com/400x175/?github summary: API docs for the visDefaultEditor plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visDefaultEditor'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_gauge.mdx b/api_docs/vis_type_gauge.mdx index 405dc50d73ce1..73b3fd805469b 100644 --- a/api_docs/vis_type_gauge.mdx +++ b/api_docs/vis_type_gauge.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeGauge title: "visTypeGauge" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeGauge plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeGauge'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_heatmap.mdx b/api_docs/vis_type_heatmap.mdx index 0ff72f3eecb86..8fced74534107 100644 --- a/api_docs/vis_type_heatmap.mdx +++ b/api_docs/vis_type_heatmap.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeHeatmap title: "visTypeHeatmap" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeHeatmap plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeHeatmap'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_pie.mdx b/api_docs/vis_type_pie.mdx index 09ac4941b257e..6f2df2634dae4 100644 --- a/api_docs/vis_type_pie.mdx +++ b/api_docs/vis_type_pie.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypePie title: "visTypePie" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypePie plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypePie'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_table.mdx b/api_docs/vis_type_table.mdx index 1929113958171..399fdf3d04609 100644 --- a/api_docs/vis_type_table.mdx +++ b/api_docs/vis_type_table.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeTable title: "visTypeTable" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeTable plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTable'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_timelion.mdx b/api_docs/vis_type_timelion.mdx index 452fefe609534..35ceba01e9d4c 100644 --- a/api_docs/vis_type_timelion.mdx +++ b/api_docs/vis_type_timelion.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeTimelion title: "visTypeTimelion" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeTimelion plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTimelion'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_timeseries.devdocs.json b/api_docs/vis_type_timeseries.devdocs.json index afd54c07290ff..c38dbfe482781 100644 --- a/api_docs/vis_type_timeseries.devdocs.json +++ b/api_docs/vis_type_timeseries.devdocs.json @@ -128,13 +128,7 @@ "text": "DataRequestHandlerContext" }, ", fakeRequest: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ", options: any) => Promise<", "TimeseriesVisData", ">" @@ -170,13 +164,7 @@ "label": "fakeRequest", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "src/plugins/vis_types/timeseries/server/plugin.ts", diff --git a/api_docs/vis_type_timeseries.mdx b/api_docs/vis_type_timeseries.mdx index 4c58916345666..0e79bc87dad38 100644 --- a/api_docs/vis_type_timeseries.mdx +++ b/api_docs/vis_type_timeseries.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeTimeseries title: "visTypeTimeseries" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeTimeseries plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTimeseries'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_vega.mdx b/api_docs/vis_type_vega.mdx index 54687d186f301..9c7e5004768fd 100644 --- a/api_docs/vis_type_vega.mdx +++ b/api_docs/vis_type_vega.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeVega title: "visTypeVega" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeVega plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeVega'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_vislib.mdx b/api_docs/vis_type_vislib.mdx index 11e94a93a44b6..63b6b57590f6d 100644 --- a/api_docs/vis_type_vislib.mdx +++ b/api_docs/vis_type_vislib.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeVislib title: "visTypeVislib" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeVislib plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeVislib'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_xy.mdx b/api_docs/vis_type_xy.mdx index 92c8fed181ec9..7ddcc5d5423f9 100644 --- a/api_docs/vis_type_xy.mdx +++ b/api_docs/vis_type_xy.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeXy title: "visTypeXy" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeXy plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeXy'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/visualizations.devdocs.json b/api_docs/visualizations.devdocs.json index e6d13ebfd5089..07a10571b64cb 100644 --- a/api_docs/visualizations.devdocs.json +++ b/api_docs/visualizations.devdocs.json @@ -5163,7 +5163,7 @@ "section": "def-public.VisualizeInput", "text": "VisualizeInput" }, - ">) => void; getInspectorAdapters: () => ", + ">) => void; reportsEmbeddableLoad: () => boolean; getInspectorAdapters: () => ", { "pluginId": "inspector", "scope": "common", @@ -5179,7 +5179,7 @@ "section": "def-public.OverlayRef", "text": "OverlayRef" }, - " | undefined; transferCustomizationsToUiState: () => void; hasInspector: () => boolean; onContainerLoading: () => void; onContainerRender: () => void; onContainerError: (error: ", + " | undefined; transferCustomizationsToUiState: () => void; hasInspector: () => boolean; onContainerLoading: () => void; onContainerData: () => void; onContainerRender: () => void; onContainerError: (error: ", { "pluginId": "expressions", "scope": "public", diff --git a/api_docs/visualizations.mdx b/api_docs/visualizations.mdx index a1999e49711e9..13b8faa002999 100644 --- a/api_docs/visualizations.mdx +++ b/api_docs/visualizations.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visualizations title: "visualizations" image: https://source.unsplash.com/400x175/?github summary: API docs for the visualizations plugin -date: 2022-07-11 +date: 2022-07-13 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visualizations'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/examples/preboot_example/public/app.tsx b/examples/preboot_example/public/app.tsx index 39a50995f0580..095b8af4fef82 100644 --- a/examples/preboot_example/public/app.tsx +++ b/examples/preboot_example/public/app.tsx @@ -17,7 +17,7 @@ import { EuiText, } from '@elastic/eui'; import React, { useEffect, useState } from 'react'; -import type { HttpSetup, IHttpFetchError, ResponseErrorBody } from '@kbn/core/public'; +import type { HttpSetup, IHttpFetchError, ResponseErrorBody } from '@kbn/core-http-browser'; export const App = ({ http, token }: { http: HttpSetup; token?: string }) => { const onCompleteSetup = async ({ shouldReloadConfig }: { shouldReloadConfig: boolean }) => { diff --git a/examples/routing_example/public/get_message_example.tsx b/examples/routing_example/public/get_message_example.tsx index 45ad123f7bbba..677d4cd44a7b6 100644 --- a/examples/routing_example/public/get_message_example.tsx +++ b/examples/routing_example/public/get_message_example.tsx @@ -16,8 +16,7 @@ import { EuiCallOut, EuiFormRow, } from '@elastic/eui'; -import { HttpFetchError } from '@kbn/core/public'; -import { isError } from './is_error'; +import { type IHttpFetchError, isHttpFetchError } from '@kbn/core-http-browser'; import { Services } from './services'; interface Props { @@ -25,7 +24,7 @@ interface Props { } export function GetMessageRouteExample({ getMessageById }: Props) { - const [error, setError] = useState(); + const [error, setError] = useState(); const [isFetching, setIsFetching] = useState(false); const [message, setMessage] = useState(''); const [id, setId] = useState(''); @@ -35,7 +34,7 @@ export function GetMessageRouteExample({ getMessageById }: Props) { setIsFetching(true); const response = await getMessageById(id); - if (isError(response)) { + if (isHttpFetchError(response)) { setError(response); setMessage(''); } else { diff --git a/examples/routing_example/public/post_message_example.tsx b/examples/routing_example/public/post_message_example.tsx index bfaf6f09cb6c8..f25ff5c369077 100644 --- a/examples/routing_example/public/post_message_example.tsx +++ b/examples/routing_example/public/post_message_example.tsx @@ -17,8 +17,7 @@ import { EuiFormRow, EuiTextArea, } from '@elastic/eui'; -import { HttpFetchError } from '@kbn/core/public'; -import { isError } from './is_error'; +import { type IHttpFetchError, isHttpFetchError } from '@kbn/core-http-browser'; import { Services } from './services'; interface Props { @@ -27,7 +26,7 @@ interface Props { } export function PostMessageRouteExample({ postMessage, addSuccessToast }: Props) { - const [error, setError] = useState(); + const [error, setError] = useState(); const [isPosting, setIsPosting] = useState(false); const [message, setMessage] = useState(''); const [id, setId] = useState(''); @@ -37,7 +36,7 @@ export function PostMessageRouteExample({ postMessage, addSuccessToast }: Props) setIsPosting(true); const response = await postMessage(message, id); - if (response && isError(response)) { + if (response && isHttpFetchError(response)) { setError(response); } else { setError(undefined); diff --git a/examples/routing_example/public/random_number_between_example.tsx b/examples/routing_example/public/random_number_between_example.tsx index 86c20b9e7dbbb..bb6f1eac20131 100644 --- a/examples/routing_example/public/random_number_between_example.tsx +++ b/examples/routing_example/public/random_number_between_example.tsx @@ -16,8 +16,7 @@ import { EuiCallOut, EuiFormRow, } from '@elastic/eui'; -import { HttpFetchError } from '@kbn/core/public'; -import { isError } from './is_error'; +import { type IHttpFetchError, isHttpFetchError } from '@kbn/core-http-browser'; import { Services } from './services'; interface Props { @@ -25,7 +24,7 @@ interface Props { } export function RandomNumberBetweenRouteExample({ fetchRandomNumberBetween }: Props) { - const [error, setError] = useState(); + const [error, setError] = useState(); const [randomNumber, setRandomNumber] = useState(0); const [isFetching, setIsFetching] = useState(false); const [maxInput, setMaxInput] = useState('10'); @@ -35,7 +34,7 @@ export function RandomNumberBetweenRouteExample({ fetchRandomNumberBetween }: Pr setIsFetching(true); const response = await fetchRandomNumberBetween(Number.parseInt(maxInput, 10)); - if (isError(response)) { + if (isHttpFetchError(response)) { setError(response); } else { setRandomNumber(response); diff --git a/examples/routing_example/public/random_number_example.tsx b/examples/routing_example/public/random_number_example.tsx index 292093c18767c..7a2a3bf608e4b 100644 --- a/examples/routing_example/public/random_number_example.tsx +++ b/examples/routing_example/public/random_number_example.tsx @@ -9,16 +9,15 @@ import React, { useCallback } from 'react'; import { useState } from 'react'; import { EuiText, EuiButton, EuiLoadingSpinner, EuiCallOut } from '@elastic/eui'; -import { HttpFetchError } from '@kbn/core/public'; +import { type IHttpFetchError, isHttpFetchError } from '@kbn/core-http-browser'; import { Services } from './services'; -import { isError } from './is_error'; interface Props { fetchRandomNumber: Services['fetchRandomNumber']; } export function RandomNumberRouteExample({ fetchRandomNumber }: Props) { - const [error, setError] = useState(undefined); + const [error, setError] = useState(undefined); const [randomNumber, setRandomNumber] = useState(0); const [isFetching, setIsFetching] = useState(false); @@ -27,7 +26,7 @@ export function RandomNumberRouteExample({ fetchRandomNumber }: Props) { setIsFetching(true); const response = await fetchRandomNumber(); - if (isError(response)) { + if (isHttpFetchError(response)) { setError(response); } else { setRandomNumber(response); diff --git a/examples/routing_example/public/services.ts b/examples/routing_example/public/services.ts index 499d7e86a5912..d98791ff5c240 100644 --- a/examples/routing_example/public/services.ts +++ b/examples/routing_example/public/services.ts @@ -6,7 +6,8 @@ * Side Public License, v 1. */ -import { CoreStart, HttpFetchError } from '@kbn/core/public'; +import type { CoreStart } from '@kbn/core/public'; +import type { IHttpFetchError } from '@kbn/core-http-browser'; import { RANDOM_NUMBER_ROUTE_PATH, RANDOM_NUMBER_BETWEEN_ROUTE_PATH, @@ -15,10 +16,10 @@ import { } from '../common'; export interface Services { - fetchRandomNumber: () => Promise; - fetchRandomNumberBetween: (max: number) => Promise; - postMessage: (message: string, id: string) => Promise; - getMessageById: (id: string) => Promise; + fetchRandomNumber: () => Promise; + fetchRandomNumberBetween: (max: number) => Promise; + postMessage: (message: string, id: string) => Promise; + getMessageById: (id: string) => Promise; addSuccessToast: (message: string) => void; } diff --git a/package.json b/package.json index 1bc702f8c83da..addd2cde108fb 100644 --- a/package.json +++ b/package.json @@ -104,11 +104,11 @@ "@elastic/apm-rum": "^5.12.0", "@elastic/apm-rum-react": "^1.4.2", "@elastic/apm-synthtrace": "link:bazel-bin/packages/elastic-apm-synthtrace", - "@elastic/charts": "46.11.2", + "@elastic/charts": "46.12.0", "@elastic/datemath": "5.0.3", "@elastic/elasticsearch": "npm:@elastic/elasticsearch-canary@8.3.0-canary.1", "@elastic/ems-client": "8.3.3", - "@elastic/eui": "60.0.0", + "@elastic/eui": "60.1.2", "@elastic/filesaver": "1.1.2", "@elastic/node-crypto": "1.2.1", "@elastic/numeral": "^2.5.1", @@ -176,7 +176,17 @@ "@kbn/core-fatal-errors-browser": "link:bazel-bin/packages/core/fatal-errors/core-fatal-errors-browser", "@kbn/core-fatal-errors-browser-internal": "link:bazel-bin/packages/core/fatal-errors/core-fatal-errors-browser-internal", "@kbn/core-fatal-errors-browser-mocks": "link:bazel-bin/packages/core/fatal-errors/core-fatal-errors-browser-mocks", + "@kbn/core-http-browser": "link:bazel-bin/packages/core/http/core-http-browser", + "@kbn/core-http-browser-internal": "link:bazel-bin/packages/core/http/core-http-browser-internal", + "@kbn/core-http-browser-mocks": "link:bazel-bin/packages/core/http/core-http-browser-mocks", + "@kbn/core-http-common": "link:bazel-bin/packages/core/http/core-http-common", + "@kbn/core-http-context-server-internal": "link:bazel-bin/packages/core/http/core-http-context-server-internal", + "@kbn/core-http-context-server-mocks": "link:bazel-bin/packages/core/http/core-http-context-server-mocks", + "@kbn/core-http-router-server-internal": "link:bazel-bin/packages/core/http/core-http-router-server-internal", + "@kbn/core-http-router-server-mocks": "link:bazel-bin/packages/core/http/core-http-router-server-mocks", "@kbn/core-http-server": "link:bazel-bin/packages/core/http/core-http-server", + "@kbn/core-http-server-internal": "link:bazel-bin/packages/core/http/core-http-server-internal", + "@kbn/core-http-server-mocks": "link:bazel-bin/packages/core/http/core-http-server-mocks", "@kbn/core-i18n-browser": "link:bazel-bin/packages/core/i18n/core-i18n-browser", "@kbn/core-i18n-browser-internal": "link:bazel-bin/packages/core/i18n/core-i18n-browser-internal", "@kbn/core-i18n-browser-mocks": "link:bazel-bin/packages/core/i18n/core-i18n-browser-mocks", @@ -197,6 +207,7 @@ "@kbn/core-theme-browser-internal": "link:bazel-bin/packages/core/theme/core-theme-browser-internal", "@kbn/core-theme-browser-mocks": "link:bazel-bin/packages/core/theme/core-theme-browser-mocks", "@kbn/crypto": "link:bazel-bin/packages/kbn-crypto", + "@kbn/crypto-browser": "link:bazel-bin/packages/kbn-crypto-browser", "@kbn/datemath": "link:bazel-bin/packages/kbn-datemath", "@kbn/doc-links": "link:bazel-bin/packages/kbn-doc-links", "@kbn/es-errors": "link:bazel-bin/packages/kbn-es-errors", @@ -246,6 +257,7 @@ "@kbn/shared-ux-link-redirect-app": "link:bazel-bin/packages/shared-ux/link/redirect_app", "@kbn/shared-ux-page-analytics-no-data": "link:bazel-bin/packages/shared-ux/page/analytics_no_data", "@kbn/shared-ux-page-kibana-no-data": "link:bazel-bin/packages/shared-ux/page/kibana_no_data", + "@kbn/shared-ux-page-solution-nav": "link:bazel-bin/packages/shared-ux/page/solution_nav", "@kbn/shared-ux-prompt-no-data-views": "link:bazel-bin/packages/shared-ux/prompt/no_data_views", "@kbn/shared-ux-services": "link:bazel-bin/packages/kbn-shared-ux-services", "@kbn/shared-ux-storybook": "link:bazel-bin/packages/kbn-shared-ux-storybook", @@ -736,7 +748,17 @@ "@types/kbn__core-fatal-errors-browser": "link:bazel-bin/packages/core/fatal-errors/core-fatal-errors-browser/npm_module_types", "@types/kbn__core-fatal-errors-browser-internal": "link:bazel-bin/packages/core/fatal-errors/core-fatal-errors-browser-internal/npm_module_types", "@types/kbn__core-fatal-errors-browser-mocks": "link:bazel-bin/packages/core/fatal-errors/core-fatal-errors-browser-mocks/npm_module_types", + "@types/kbn__core-http-browser": "link:bazel-bin/packages/core/http/core-http-browser/npm_module_types", + "@types/kbn__core-http-browser-internal": "link:bazel-bin/packages/core/http/core-http-browser-internal/npm_module_types", + "@types/kbn__core-http-browser-mocks": "link:bazel-bin/packages/core/http/core-http-browser-mocks/npm_module_types", + "@types/kbn__core-http-common": "link:bazel-bin/packages/core/http/core-http-common/npm_module_types", + "@types/kbn__core-http-context-server-internal": "link:bazel-bin/packages/core/http/core-http-context-server-internal/npm_module_types", + "@types/kbn__core-http-context-server-mocks": "link:bazel-bin/packages/core/http/core-http-context-server-mocks/npm_module_types", + "@types/kbn__core-http-router-server-internal": "link:bazel-bin/packages/core/http/core-http-router-server-internal/npm_module_types", + "@types/kbn__core-http-router-server-mocks": "link:bazel-bin/packages/core/http/core-http-router-server-mocks/npm_module_types", "@types/kbn__core-http-server": "link:bazel-bin/packages/core/http/core-http-server/npm_module_types", + "@types/kbn__core-http-server-internal": "link:bazel-bin/packages/core/http/core-http-server-internal/npm_module_types", + "@types/kbn__core-http-server-mocks": "link:bazel-bin/packages/core/http/core-http-server-mocks/npm_module_types", "@types/kbn__core-i18n-browser": "link:bazel-bin/packages/core/i18n/core-i18n-browser/npm_module_types", "@types/kbn__core-i18n-browser-internal": "link:bazel-bin/packages/core/i18n/core-i18n-browser-internal/npm_module_types", "@types/kbn__core-i18n-browser-mocks": "link:bazel-bin/packages/core/i18n/core-i18n-browser-mocks/npm_module_types", @@ -759,6 +781,7 @@ "@types/kbn__core-theme-browser-internal": "link:bazel-bin/packages/core/theme/core-theme-browser-internal/npm_module_types", "@types/kbn__core-theme-browser-mocks": "link:bazel-bin/packages/core/theme/core-theme-browser-mocks/npm_module_types", "@types/kbn__crypto": "link:bazel-bin/packages/kbn-crypto/npm_module_types", + "@types/kbn__crypto-browser": "link:bazel-bin/packages/kbn-crypto-browser/npm_module_types", "@types/kbn__datemath": "link:bazel-bin/packages/kbn-datemath/npm_module_types", "@types/kbn__dev-cli-errors": "link:bazel-bin/packages/kbn-dev-cli-errors/npm_module_types", "@types/kbn__dev-cli-runner": "link:bazel-bin/packages/kbn-dev-cli-runner/npm_module_types", @@ -824,6 +847,7 @@ "@types/kbn__shared-ux-link-redirect-app": "link:bazel-bin/packages/shared-ux/link/redirect_app/npm_module_types", "@types/kbn__shared-ux-page-analytics-no-data": "link:bazel-bin/packages/shared-ux/page/analytics_no_data/npm_module_types", "@types/kbn__shared-ux-page-kibana-no-data": "link:bazel-bin/packages/shared-ux/page/kibana_no_data/npm_module_types", + "@types/kbn__shared-ux-page-solution-nav": "link:bazel-bin/packages/shared-ux/page/solution_nav/npm_module_types", "@types/kbn__shared-ux-prompt-no-data-views": "link:bazel-bin/packages/shared-ux/prompt/no_data_views/npm_module_types", "@types/kbn__shared-ux-services": "link:bazel-bin/packages/kbn-shared-ux-services/npm_module_types", "@types/kbn__shared-ux-storybook": "link:bazel-bin/packages/kbn-shared-ux-storybook/npm_module_types", @@ -959,7 +983,6 @@ "babel-plugin-transform-react-remove-prop-types": "^0.4.24", "backport": "^8.8.0", "callsites": "^3.1.0", - "chai": "3.5.0", "chance": "1.0.18", "chokidar": "^3.4.3", "chromedriver": "^103.0.0", @@ -1012,7 +1035,6 @@ "expose-loader": "^0.7.5", "faker": "^5.1.0", "fancy-log": "^1.3.2", - "fast-glob": "2.2.7", "fetch-mock": "^7.3.9", "file-loader": "^4.2.0", "form-data": "^4.0.0", @@ -1069,7 +1091,7 @@ "mutation-observer": "^1.0.3", "ncp": "^2.0.0", "nock": "12.0.3", - "node-sass": "6.0.1", + "node-sass": "7.0.1", "null-loader": "^3.0.0", "nyc": "^15.1.0", "oboe": "^2.1.4", @@ -1091,14 +1113,12 @@ "regenerate": "^1.4.0", "resolve": "^1.22.0", "rxjs-marbles": "^5.0.6", - "sass-loader": "^10.2.0", + "sass-loader": "^10.3.1", "selenium-webdriver": "^4.3.0", - "shelljs": "^0.8.4", "simple-git": "1.116.0", "sinon": "^7.4.2", "sort-package-json": "^1.53.1", "source-map": "^0.7.3", - "spawn-sync": "^1.0.15", "string-replace-loader": "^2.2.0", "strong-log-transformer": "^2.1.0", "style-loader": "^1.1.3", @@ -1131,7 +1151,6 @@ "write-pkg": "^4.0.0", "xml-crypto": "^2.1.3", "xmlbuilder": "13.0.2", - "yargs": "^15.4.1", - "zlib": "^1.0.5" + "yargs": "^15.4.1" } } diff --git a/packages/BUILD.bazel b/packages/BUILD.bazel index b632fc261f0a1..8d39cf240970b 100644 --- a/packages/BUILD.bazel +++ b/packages/BUILD.bazel @@ -45,6 +45,16 @@ filegroup( "//packages/core/fatal-errors/core-fatal-errors-browser-internal:build", "//packages/core/fatal-errors/core-fatal-errors-browser-mocks:build", "//packages/core/fatal-errors/core-fatal-errors-browser:build", + "//packages/core/http/core-http-browser-internal:build", + "//packages/core/http/core-http-browser-mocks:build", + "//packages/core/http/core-http-browser:build", + "//packages/core/http/core-http-common:build", + "//packages/core/http/core-http-context-server-internal:build", + "//packages/core/http/core-http-context-server-mocks:build", + "//packages/core/http/core-http-router-server-internal:build", + "//packages/core/http/core-http-router-server-mocks:build", + "//packages/core/http/core-http-server-internal:build", + "//packages/core/http/core-http-server-mocks:build", "//packages/core/http/core-http-server:build", "//packages/core/i18n/core-i18n-browser-internal:build", "//packages/core/i18n/core-i18n-browser-mocks:build", @@ -88,6 +98,7 @@ filegroup( "//packages/kbn-config-mocks:build", "//packages/kbn-config-schema:build", "//packages/kbn-config:build", + "//packages/kbn-crypto-browser:build", "//packages/kbn-crypto:build", "//packages/kbn-datemath:build", "//packages/kbn-dev-cli-errors:build", @@ -181,6 +192,7 @@ filegroup( "//packages/shared-ux/link/redirect_app:build", "//packages/shared-ux/page/analytics_no_data:build", "//packages/shared-ux/page/kibana_no_data:build", + "//packages/shared-ux/page/solution_nav:build", "//packages/shared-ux/prompt/no_data_views:build", "//x-pack/packages/ml/agg_utils:build", "//x-pack/packages/ml/aiops_components:build", @@ -230,6 +242,16 @@ filegroup( "//packages/core/fatal-errors/core-fatal-errors-browser-internal:build_types", "//packages/core/fatal-errors/core-fatal-errors-browser-mocks:build_types", "//packages/core/fatal-errors/core-fatal-errors-browser:build_types", + "//packages/core/http/core-http-browser-internal:build_types", + "//packages/core/http/core-http-browser-mocks:build_types", + "//packages/core/http/core-http-browser:build_types", + "//packages/core/http/core-http-common:build_types", + "//packages/core/http/core-http-context-server-internal:build_types", + "//packages/core/http/core-http-context-server-mocks:build_types", + "//packages/core/http/core-http-router-server-internal:build_types", + "//packages/core/http/core-http-router-server-mocks:build_types", + "//packages/core/http/core-http-server-internal:build_types", + "//packages/core/http/core-http-server-mocks:build_types", "//packages/core/http/core-http-server:build_types", "//packages/core/i18n/core-i18n-browser-internal:build_types", "//packages/core/i18n/core-i18n-browser-mocks:build_types", @@ -269,6 +291,7 @@ filegroup( "//packages/kbn-config-mocks:build_types", "//packages/kbn-config-schema:build_types", "//packages/kbn-config:build_types", + "//packages/kbn-crypto-browser:build_types", "//packages/kbn-crypto:build_types", "//packages/kbn-datemath:build_types", "//packages/kbn-dev-cli-errors:build_types", @@ -351,6 +374,7 @@ filegroup( "//packages/shared-ux/link/redirect_app:build_types", "//packages/shared-ux/page/analytics_no_data:build_types", "//packages/shared-ux/page/kibana_no_data:build_types", + "//packages/shared-ux/page/solution_nav:build_types", "//packages/shared-ux/prompt/no_data_views:build_types", "//x-pack/packages/ml/agg_utils:build_types", "//x-pack/packages/ml/aiops_components:build_types", diff --git a/packages/core/http/core-http-browser-internal/BUILD.bazel b/packages/core/http/core-http-browser-internal/BUILD.bazel new file mode 100644 index 0000000000000..b23247933cc86 --- /dev/null +++ b/packages/core/http/core-http-browser-internal/BUILD.bazel @@ -0,0 +1,119 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "core-http-browser-internal" +PKG_REQUIRE_NAME = "@kbn/core-http-browser-internal" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + "src/**/*.tsx", + ], + exclude = [ + "**/*.test.*", + "**/*.story.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +RUNTIME_DEPS = [ + "@npm//lodash", + "@npm//rxjs", + "//packages/core/execution-context/core-execution-context-browser-internal", + "//packages/core/injected-metadata/core-injected-metadata-browser-mocks", + "//packages/kbn-crypto-browser", + "//packages/kbn-std", +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", + "//packages/core/base/core-base-browser-internal:npm_module_types", + "//packages/core/http/core-http-browser:npm_module_types", + "//packages/core/http/core-http-common:npm_module_types", + "//packages/core/execution-context/core-execution-context-browser-internal:npm_module_types", + "//packages/core/execution-context/core-execution-context-browser:npm_module_types", + "//packages/core/fatal-errors/core-fatal-errors-browser:npm_module_types", + "//packages/core/injected-metadata/core-injected-metadata-browser-internal:npm_module_types", + "//packages/kbn-crypto-browser:npm_module_types", + "//packages/kbn-std:npm_module_types", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +jsts_transpiler( + name = "target_web", + srcs = SRCS, + build_pkg_name = package_name(), + web = True, +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node", ":target_web"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/core/http/core-http-browser-internal/README.md b/packages/core/http/core-http-browser-internal/README.md new file mode 100644 index 0000000000000..ea0759ee587b8 --- /dev/null +++ b/packages/core/http/core-http-browser-internal/README.md @@ -0,0 +1,3 @@ +# @kbn/core-http-browser-internal + +This package contains the internal types and implementation for Core's browser-side HTTP service. diff --git a/packages/core/http/core-http-browser-internal/jest.config.js b/packages/core/http/core-http-browser-internal/jest.config.js new file mode 100644 index 0000000000000..72c097b053e7d --- /dev/null +++ b/packages/core/http/core-http-browser-internal/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test', + rootDir: '../../../..', + roots: ['/packages/core/http/core-http-browser-internal'], +}; diff --git a/packages/core/http/core-http-browser-internal/package.json b/packages/core/http/core-http-browser-internal/package.json new file mode 100644 index 0000000000000..38afd6f60852a --- /dev/null +++ b/packages/core/http/core-http-browser-internal/package.json @@ -0,0 +1,8 @@ +{ + "name": "@kbn/core-http-browser-internal", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "browser": "./target_web/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/src/core/public/http/_import_objects.ndjson b/packages/core/http/core-http-browser-internal/src/_import_objects.ndjson similarity index 100% rename from src/core/public/http/_import_objects.ndjson rename to packages/core/http/core-http-browser-internal/src/_import_objects.ndjson diff --git a/src/core/public/http/anonymous_paths_service.test.ts b/packages/core/http/core-http-browser-internal/src/anonymous_paths_service.test.ts similarity index 100% rename from src/core/public/http/anonymous_paths_service.test.ts rename to packages/core/http/core-http-browser-internal/src/anonymous_paths_service.test.ts diff --git a/src/core/public/http/anonymous_paths_service.ts b/packages/core/http/core-http-browser-internal/src/anonymous_paths_service.ts similarity index 95% rename from src/core/public/http/anonymous_paths_service.ts rename to packages/core/http/core-http-browser-internal/src/anonymous_paths_service.ts index f3b47ab0eda30..f91a646bfd171 100644 --- a/src/core/public/http/anonymous_paths_service.ts +++ b/packages/core/http/core-http-browser-internal/src/anonymous_paths_service.ts @@ -7,7 +7,7 @@ */ import type { CoreService } from '@kbn/core-base-browser-internal'; -import { IAnonymousPaths, IBasePath } from '..'; +import type { IAnonymousPaths, IBasePath } from '@kbn/core-http-browser'; interface Deps { basePath: IBasePath; diff --git a/src/core/public/http/base_path.test.ts b/packages/core/http/core-http-browser-internal/src/base_path.test.ts similarity index 100% rename from src/core/public/http/base_path.test.ts rename to packages/core/http/core-http-browser-internal/src/base_path.test.ts diff --git a/src/core/public/http/base_path.ts b/packages/core/http/core-http-browser-internal/src/base_path.ts similarity index 92% rename from src/core/public/http/base_path.ts rename to packages/core/http/core-http-browser-internal/src/base_path.ts index 166deab54a2bf..63fb8917421e0 100644 --- a/src/core/public/http/base_path.ts +++ b/packages/core/http/core-http-browser-internal/src/base_path.ts @@ -6,9 +6,10 @@ * Side Public License, v 1. */ +import { IBasePath } from '@kbn/core-http-browser'; import { modifyUrl } from '@kbn/std'; -export class BasePath { +export class BasePath implements IBasePath { constructor( private readonly basePath: string = '', public readonly serverBasePath: string = basePath, diff --git a/src/core/public/http/external_url_service.test.ts b/packages/core/http/core-http-browser-internal/src/external_url_service.test.ts similarity index 98% rename from src/core/public/http/external_url_service.test.ts rename to packages/core/http/core-http-browser-internal/src/external_url_service.test.ts index c2d7725bf1bed..51db238a08383 100644 --- a/src/core/public/http/external_url_service.test.ts +++ b/packages/core/http/core-http-browser-internal/src/external_url_service.test.ts @@ -6,10 +6,9 @@ * Side Public License, v 1. */ -import { ExternalUrlConfig } from '../../server/types'; - -import { injectedMetadataServiceMock } from '../mocks'; -import { Sha256 } from '../utils'; +import { Sha256 } from '@kbn/crypto-browser'; +import type { IExternalUrlPolicy } from '@kbn/core-http-common'; +import { injectedMetadataServiceMock } from '@kbn/core-injected-metadata-browser-mocks'; import { ExternalUrlService } from './external_url_service'; @@ -20,7 +19,7 @@ const setupService = ({ }: { location: URL; serverBasePath: string; - policy: ExternalUrlConfig['policy']; + policy: IExternalUrlPolicy[]; }) => { const hashedPolicies = policy.map((entry) => { // If the host contains a `[`, then it's likely an IPv6 address. Otherwise, append a `.` if it doesn't already contain one diff --git a/src/core/public/http/external_url_service.ts b/packages/core/http/core-http-browser-internal/src/external_url_service.ts similarity index 95% rename from src/core/public/http/external_url_service.ts rename to packages/core/http/core-http-browser-internal/src/external_url_service.ts index 0e5994a253ace..5b5b0940377f2 100644 --- a/src/core/public/http/external_url_service.ts +++ b/packages/core/http/core-http-browser-internal/src/external_url_service.ts @@ -6,11 +6,11 @@ * Side Public License, v 1. */ +import { Sha256 } from '@kbn/crypto-browser'; import type { CoreService } from '@kbn/core-base-browser-internal'; +import type { IExternalUrl } from '@kbn/core-http-browser'; +import type { IExternalUrlPolicy } from '@kbn/core-http-common'; import type { InternalInjectedMetadataSetup } from '@kbn/core-injected-metadata-browser-internal'; -import { IExternalUrlPolicy } from '../../server/types'; -import { IExternalUrl } from './types'; -import { Sha256 } from '../utils'; interface SetupDeps { location: Pick; diff --git a/src/core/public/http/fetch.test.ts b/packages/core/http/core-http-browser-internal/src/fetch.test.ts similarity index 99% rename from src/core/public/http/fetch.test.ts rename to packages/core/http/core-http-browser-internal/src/fetch.test.ts index 26da5546a0a84..6938bf07b3f0e 100644 --- a/src/core/public/http/fetch.test.ts +++ b/packages/core/http/core-http-browser-internal/src/fetch.test.ts @@ -12,10 +12,10 @@ import { readFileSync } from 'fs'; import { join } from 'path'; import { first } from 'rxjs/operators'; import { executionContextServiceMock } from '@kbn/core-execution-context-browser-mocks'; +import type { HttpResponse, HttpFetchOptionsWithPath } from '@kbn/core-http-browser'; import { Fetch } from './fetch'; import { BasePath } from './base_path'; -import { HttpResponse, HttpFetchOptionsWithPath } from './types'; function delay(duration: number) { return new Promise((r) => setTimeout(r, duration)); diff --git a/src/core/public/http/fetch.ts b/packages/core/http/core-http-browser-internal/src/fetch.ts similarity index 99% rename from src/core/public/http/fetch.ts rename to packages/core/http/core-http-browser-internal/src/fetch.ts index 3df1b558bb7e3..7726a0d4d111a 100644 --- a/src/core/public/http/fetch.ts +++ b/packages/core/http/core-http-browser-internal/src/fetch.ts @@ -18,7 +18,7 @@ import type { HttpFetchOptions, HttpResponse, HttpFetchOptionsWithPath, -} from './types'; +} from '@kbn/core-http-browser'; import { HttpFetchError } from './http_fetch_error'; import { HttpInterceptController } from './http_intercept_controller'; import { interceptRequest, interceptResponse } from './intercept'; diff --git a/src/core/public/http/http_fetch_error.ts b/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts similarity index 94% rename from src/core/public/http/http_fetch_error.ts rename to packages/core/http/core-http-browser-internal/src/http_fetch_error.ts index 0c37fa40a16d0..80947b5988a7b 100644 --- a/src/core/public/http/http_fetch_error.ts +++ b/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { IHttpFetchError } from './types'; +import type { IHttpFetchError } from '@kbn/core-http-browser'; /** @internal */ export class HttpFetchError extends Error implements IHttpFetchError { diff --git a/src/core/public/http/http_intercept_controller.ts b/packages/core/http/core-http-browser-internal/src/http_intercept_controller.ts similarity index 88% rename from src/core/public/http/http_intercept_controller.ts rename to packages/core/http/core-http-browser-internal/src/http_intercept_controller.ts index c1ded9ddb1afb..643aa38a2a4ed 100644 --- a/src/core/public/http/http_intercept_controller.ts +++ b/packages/core/http/core-http-browser-internal/src/http_intercept_controller.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { IHttpInterceptController } from './types'; +import type { IHttpInterceptController } from '@kbn/core-http-browser'; /** @internal */ export class HttpInterceptController implements IHttpInterceptController { diff --git a/src/core/public/http/http_intercept_halt_error.ts b/packages/core/http/core-http-browser-internal/src/http_intercept_halt_error.ts similarity index 100% rename from src/core/public/http/http_intercept_halt_error.ts rename to packages/core/http/core-http-browser-internal/src/http_intercept_halt_error.ts diff --git a/src/core/public/http/http_service.test.mocks.ts b/packages/core/http/core-http-browser-internal/src/http_service.test.mocks.ts similarity index 100% rename from src/core/public/http/http_service.test.mocks.ts rename to packages/core/http/core-http-browser-internal/src/http_service.test.mocks.ts diff --git a/src/core/public/http/http_service.test.ts b/packages/core/http/core-http-browser-internal/src/http_service.test.ts similarity index 100% rename from src/core/public/http/http_service.test.ts rename to packages/core/http/core-http-browser-internal/src/http_service.test.ts diff --git a/src/core/public/http/http_service.ts b/packages/core/http/core-http-browser-internal/src/http_service.ts similarity index 97% rename from src/core/public/http/http_service.ts rename to packages/core/http/core-http-browser-internal/src/http_service.ts index 80b6d3cb81c3c..d2d0913afae94 100644 --- a/src/core/public/http/http_service.ts +++ b/packages/core/http/core-http-browser-internal/src/http_service.ts @@ -10,7 +10,7 @@ import type { CoreService } from '@kbn/core-base-browser-internal'; import type { ExecutionContextSetup } from '@kbn/core-execution-context-browser'; import type { InternalInjectedMetadataSetup } from '@kbn/core-injected-metadata-browser-internal'; import type { FatalErrorsSetup } from '@kbn/core-fatal-errors-browser'; -import { HttpSetup, HttpStart } from './types'; +import type { HttpSetup, HttpStart } from '@kbn/core-http-browser'; import { BasePath } from './base_path'; import { AnonymousPathsService } from './anonymous_paths_service'; import { LoadingCountService } from './loading_count_service'; diff --git a/src/core/public/http/index.ts b/packages/core/http/core-http-browser-internal/src/index.ts similarity index 83% rename from src/core/public/http/index.ts rename to packages/core/http/core-http-browser-internal/src/index.ts index ba9470ae78726..348ce6ee4c0ee 100644 --- a/src/core/public/http/index.ts +++ b/packages/core/http/core-http-browser-internal/src/index.ts @@ -6,6 +6,5 @@ * Side Public License, v 1. */ +export { BasePath } from './base_path'; export { HttpService } from './http_service'; -export { HttpFetchError } from './http_fetch_error'; -export * from './types'; diff --git a/src/core/public/http/intercept.ts b/packages/core/http/core-http-browser-internal/src/intercept.ts similarity index 97% rename from src/core/public/http/intercept.ts rename to packages/core/http/core-http-browser-internal/src/intercept.ts index 54890e4292017..a50e76c35b07f 100644 --- a/src/core/public/http/intercept.ts +++ b/packages/core/http/core-http-browser-internal/src/intercept.ts @@ -6,9 +6,13 @@ * Side Public License, v 1. */ +import type { + HttpInterceptor, + HttpResponse, + HttpFetchOptionsWithPath, +} from '@kbn/core-http-browser'; import { HttpInterceptController } from './http_intercept_controller'; import { HttpInterceptHaltError } from './http_intercept_halt_error'; -import { HttpInterceptor, HttpResponse, HttpFetchOptionsWithPath } from './types'; export async function interceptRequest( options: HttpFetchOptionsWithPath, diff --git a/src/core/public/http/loading_count_service.mock.ts b/packages/core/http/core-http-browser-internal/src/loading_count_service.mock.ts similarity index 93% rename from src/core/public/http/loading_count_service.mock.ts rename to packages/core/http/core-http-browser-internal/src/loading_count_service.mock.ts index 181769db3f125..41ed869aa1b96 100644 --- a/src/core/public/http/loading_count_service.mock.ts +++ b/packages/core/http/core-http-browser-internal/src/loading_count_service.mock.ts @@ -6,9 +6,9 @@ * Side Public License, v 1. */ -import { LoadingCountSetup, LoadingCountService } from './loading_count_service'; import { BehaviorSubject } from 'rxjs'; import type { PublicMethodsOf } from '@kbn/utility-types'; +import type { LoadingCountSetup, LoadingCountService } from './loading_count_service'; const createSetupContractMock = () => { const setupContract: jest.Mocked = { diff --git a/src/core/public/http/loading_count_service.test.ts b/packages/core/http/core-http-browser-internal/src/loading_count_service.test.ts similarity index 100% rename from src/core/public/http/loading_count_service.test.ts rename to packages/core/http/core-http-browser-internal/src/loading_count_service.test.ts diff --git a/src/core/public/http/loading_count_service.ts b/packages/core/http/core-http-browser-internal/src/loading_count_service.ts similarity index 100% rename from src/core/public/http/loading_count_service.ts rename to packages/core/http/core-http-browser-internal/src/loading_count_service.ts diff --git a/packages/core/http/core-http-browser-internal/tsconfig.json b/packages/core/http/core-http-browser-internal/tsconfig.json new file mode 100644 index 0000000000000..97a3644c3c703 --- /dev/null +++ b/packages/core/http/core-http-browser-internal/tsconfig.json @@ -0,0 +1,17 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/core/http/core-http-browser-mocks/BUILD.bazel b/packages/core/http/core-http-browser-mocks/BUILD.bazel new file mode 100644 index 0000000000000..31b5ec9b8ece2 --- /dev/null +++ b/packages/core/http/core-http-browser-mocks/BUILD.bazel @@ -0,0 +1,109 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "core-http-browser-mocks" +PKG_REQUIRE_NAME = "@kbn/core-http-browser-mocks" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + "src/**/*.tsx", + ], + exclude = [ + "**/*.test.*", + "**/*.story.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +RUNTIME_DEPS = [ + "@npm//rxjs", + "//packages/core/http/core-http-browser-internal", +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", + "//packages/kbn-utility-types:npm_module_types", + "//packages/core/http/core-http-browser-internal:npm_module_types", + "//packages/core/http/core-http-browser:npm_module_types", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +jsts_transpiler( + name = "target_web", + srcs = SRCS, + build_pkg_name = package_name(), + web = True, +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node", ":target_web"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/core/http/core-http-browser-mocks/README.md b/packages/core/http/core-http-browser-mocks/README.md new file mode 100644 index 0000000000000..12252aeb00dd6 --- /dev/null +++ b/packages/core/http/core-http-browser-mocks/README.md @@ -0,0 +1,3 @@ +# @kbn/core-http-browser-mocks + +This package contains useful mocks for Core's HTTP browser-side packages. diff --git a/packages/core/http/core-http-browser-mocks/jest.config.js b/packages/core/http/core-http-browser-mocks/jest.config.js new file mode 100644 index 0000000000000..24dce6f2c76a5 --- /dev/null +++ b/packages/core/http/core-http-browser-mocks/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test', + rootDir: '../../../..', + roots: ['/packages/core/http/core-http-browser-mocks'], +}; diff --git a/packages/core/http/core-http-browser-mocks/package.json b/packages/core/http/core-http-browser-mocks/package.json new file mode 100644 index 0000000000000..74ca04ffb8237 --- /dev/null +++ b/packages/core/http/core-http-browser-mocks/package.json @@ -0,0 +1,8 @@ +{ + "name": "@kbn/core-http-browser-mocks", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "browser": "./target_web/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/src/core/public/http/base_path.mock.ts b/packages/core/http/core-http-browser-mocks/src/base_path.mock.ts similarity index 92% rename from src/core/public/http/base_path.mock.ts rename to packages/core/http/core-http-browser-mocks/src/base_path.mock.ts index f5a0b23162be4..9d36d4e33c106 100644 --- a/src/core/public/http/base_path.mock.ts +++ b/packages/core/http/core-http-browser-mocks/src/base_path.mock.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { IBasePath } from './types'; +import type { IBasePath } from '@kbn/core-http-browser'; const createBasePathMock = ({ publicBaseUrl = '/', diff --git a/packages/core/http/core-http-browser-mocks/src/fetch_error.mock.ts b/packages/core/http/core-http-browser-mocks/src/fetch_error.mock.ts new file mode 100644 index 0000000000000..33c62e84e38d4 --- /dev/null +++ b/packages/core/http/core-http-browser-mocks/src/fetch_error.mock.ts @@ -0,0 +1,26 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 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 { IHttpFetchError } from '@kbn/core-http-browser'; + +export function createHttpFetchError( + message: string, + name: string = 'error', + request = {} as Request, + response?: Response, + body?: TResponseBody +): IHttpFetchError { + return Object.assign(new Error(message), { + name, + request, + response, + req: request, + res: response, + body, + }); +} diff --git a/src/core/public/http/http_service.mock.ts b/packages/core/http/core-http-browser-mocks/src/http_service.mock.ts similarity index 93% rename from src/core/public/http/http_service.mock.ts rename to packages/core/http/core-http-browser-mocks/src/http_service.mock.ts index bfd81a1003736..553e09875ae9e 100644 --- a/src/core/public/http/http_service.mock.ts +++ b/packages/core/http/core-http-browser-mocks/src/http_service.mock.ts @@ -6,11 +6,10 @@ * Side Public License, v 1. */ -import type { PublicMethodsOf } from '@kbn/utility-types'; -import { HttpService } from './http_service'; -import { HttpSetup } from './types'; import { BehaviorSubject } from 'rxjs'; -import { BasePath } from './base_path'; +import { type HttpService, BasePath } from '@kbn/core-http-browser-internal'; +import type { HttpSetup } from '@kbn/core-http-browser'; +import type { PublicMethodsOf } from '@kbn/utility-types'; import { basePathMock } from './base_path.mock'; export type HttpSetupMock = jest.Mocked & { diff --git a/packages/kbn-shared-ux-components/src/page_template/solution_nav/index.ts b/packages/core/http/core-http-browser-mocks/src/index.ts similarity index 51% rename from packages/kbn-shared-ux-components/src/page_template/solution_nav/index.ts rename to packages/core/http/core-http-browser-mocks/src/index.ts index 59ef2924b048d..3e0e9432bd31c 100644 --- a/packages/kbn-shared-ux-components/src/page_template/solution_nav/index.ts +++ b/packages/core/http/core-http-browser-mocks/src/index.ts @@ -6,7 +6,6 @@ * Side Public License, v 1. */ -export type { KibanaPageTemplateSolutionNavProps } from './solution_nav'; -export { KibanaPageTemplateSolutionNav } from './solution_nav'; -export type { KibanaPageTemplateSolutionNavCollapseButtonProps } from './solution_nav_collapse_button'; -export { KibanaPageTemplateSolutionNavCollapseButton } from './solution_nav_collapse_button'; +export type { HttpSetupMock } from './http_service.mock'; +export { httpServiceMock } from './http_service.mock'; +export { createHttpFetchError } from './fetch_error.mock'; diff --git a/packages/core/http/core-http-browser-mocks/tsconfig.json b/packages/core/http/core-http-browser-mocks/tsconfig.json new file mode 100644 index 0000000000000..97a3644c3c703 --- /dev/null +++ b/packages/core/http/core-http-browser-mocks/tsconfig.json @@ -0,0 +1,17 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/core/http/core-http-browser/BUILD.bazel b/packages/core/http/core-http-browser/BUILD.bazel new file mode 100644 index 0000000000000..271bcf1b76fa7 --- /dev/null +++ b/packages/core/http/core-http-browser/BUILD.bazel @@ -0,0 +1,105 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "core-http-browser" +PKG_REQUIRE_NAME = "@kbn/core-http-browser" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + "src/**/*.tsx", + ], + exclude = [ + "**/*.test.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +RUNTIME_DEPS = [ +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//rxjs", + "//packages/kbn-utility-types:npm_module_types", + "//packages/core/execution-context/core-execution-context-common:npm_module_types", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +jsts_transpiler( + name = "target_web", + srcs = SRCS, + build_pkg_name = package_name(), + web = True, +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node", ":target_web"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/core/http/core-http-browser/README.md b/packages/core/http/core-http-browser/README.md new file mode 100644 index 0000000000000..d6bfada16b9cd --- /dev/null +++ b/packages/core/http/core-http-browser/README.md @@ -0,0 +1,3 @@ +# @kbn/core-http-browser + +This package contains the public types for Core's browser-side HTTP service. diff --git a/packages/core/http/core-http-browser/jest.config.js b/packages/core/http/core-http-browser/jest.config.js new file mode 100644 index 0000000000000..cbd6195e754bc --- /dev/null +++ b/packages/core/http/core-http-browser/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test', + rootDir: '../../../..', + roots: ['/packages/core/http/core-http-browser'], +}; diff --git a/packages/core/http/core-http-browser/package.json b/packages/core/http/core-http-browser/package.json new file mode 100644 index 0000000000000..6a07daeaca7ea --- /dev/null +++ b/packages/core/http/core-http-browser/package.json @@ -0,0 +1,8 @@ +{ + "name": "@kbn/core-http-browser", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "browser": "./target_web/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/packages/core/http/core-http-browser/src/index.ts b/packages/core/http/core-http-browser/src/index.ts new file mode 100644 index 0000000000000..9b258d4eed67e --- /dev/null +++ b/packages/core/http/core-http-browser/src/index.ts @@ -0,0 +1,31 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export type { + HttpSetup, + HttpStart, + IBasePath, + IExternalUrl, + IAnonymousPaths, + HttpHeadersInit, + HttpRequestInit, + HttpFetchQuery, + HttpFetchOptions, + HttpFetchOptionsWithPath, + HttpHandler, + HttpResponse, + IHttpResponseInterceptorOverrides, + ResponseErrorBody, + IHttpFetchError, + HttpInterceptorResponseError, + HttpInterceptorRequestError, + HttpInterceptor, + IHttpInterceptController, +} from './types'; + +export { isHttpFetchError } from './utils'; diff --git a/src/core/public/http/types.ts b/packages/core/http/core-http-browser/src/types.ts similarity index 99% rename from src/core/public/http/types.ts rename to packages/core/http/core-http-browser/src/types.ts index 0e348d02575ba..313877378d1da 100644 --- a/src/core/public/http/types.ts +++ b/packages/core/http/core-http-browser/src/types.ts @@ -6,8 +6,8 @@ * Side Public License, v 1. */ -import { Observable } from 'rxjs'; -import { MaybePromise } from '@kbn/utility-types'; +import type { Observable } from 'rxjs'; +import type { MaybePromise } from '@kbn/utility-types'; import type { KibanaExecutionContext } from '@kbn/core-execution-context-common'; /** @public */ diff --git a/packages/core/http/core-http-browser/src/utils.ts b/packages/core/http/core-http-browser/src/utils.ts new file mode 100644 index 0000000000000..2ecd61ee5ca10 --- /dev/null +++ b/packages/core/http/core-http-browser/src/utils.ts @@ -0,0 +1,14 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { IHttpFetchError } from './types'; + +/** @public */ +export function isHttpFetchError(error: T | IHttpFetchError): error is IHttpFetchError { + return error instanceof Error && ('request' in error || 'req' in error) && 'name' in error; +} diff --git a/packages/core/http/core-http-browser/tsconfig.json b/packages/core/http/core-http-browser/tsconfig.json new file mode 100644 index 0000000000000..97a3644c3c703 --- /dev/null +++ b/packages/core/http/core-http-browser/tsconfig.json @@ -0,0 +1,17 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/core/http/core-http-common/BUILD.bazel b/packages/core/http/core-http-common/BUILD.bazel new file mode 100644 index 0000000000000..be4db29029555 --- /dev/null +++ b/packages/core/http/core-http-common/BUILD.bazel @@ -0,0 +1,104 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "core-http-common" +PKG_REQUIRE_NAME = "@kbn/core-http-common" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + "src/**/*.tsx", + ], + exclude = [ + "**/*.test.*", + "**/*.story.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +RUNTIME_DEPS = [ +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +jsts_transpiler( + name = "target_web", + srcs = SRCS, + build_pkg_name = package_name(), + web = True, +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node", ":target_web"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/core/http/core-http-common/README.md b/packages/core/http/core-http-common/README.md new file mode 100644 index 0000000000000..0b2d4ddf7e3ec --- /dev/null +++ b/packages/core/http/core-http-common/README.md @@ -0,0 +1,3 @@ +# @kbn/core-http-common + +This package contains the common types for Core's HTTP service and utils. diff --git a/packages/core/http/core-http-common/jest.config.js b/packages/core/http/core-http-common/jest.config.js new file mode 100644 index 0000000000000..1a77b23594ed8 --- /dev/null +++ b/packages/core/http/core-http-common/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test', + rootDir: '../../../..', + roots: ['/packages/core/http/core-http-common'], +}; diff --git a/packages/core/http/core-http-common/package.json b/packages/core/http/core-http-common/package.json new file mode 100644 index 0000000000000..62d50668d283e --- /dev/null +++ b/packages/core/http/core-http-common/package.json @@ -0,0 +1,8 @@ +{ + "name": "@kbn/core-http-common", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "browser": "./target_web/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/packages/core/http/core-http-common/src/external_url_policy.ts b/packages/core/http/core-http-common/src/external_url_policy.ts new file mode 100644 index 0000000000000..d83ba868d3589 --- /dev/null +++ b/packages/core/http/core-http-common/src/external_url_policy.ts @@ -0,0 +1,44 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 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. + */ + +/** + * A policy describing whether access to an external destination is allowed. + * @public + */ +export interface IExternalUrlPolicy { + /** + * Indicates if this policy allows or denies access to the described destination. + */ + allow: boolean; + + /** + * Optional host describing the external destination. + * May be combined with `protocol`. + * + * @example + * ```ts + * // allows access to all of google.com, using any protocol. + * allow: true, + * host: 'google.com' + * ``` + */ + host?: string; + + /** + * Optional protocol describing the external destination. + * May be combined with `host`. + * + * @example + * ```ts + * // allows access to all destinations over the `https` protocol. + * allow: true, + * protocol: 'https' + * ``` + */ + protocol?: string; +} diff --git a/examples/routing_example/public/is_error.ts b/packages/core/http/core-http-common/src/index.ts similarity index 66% rename from examples/routing_example/public/is_error.ts rename to packages/core/http/core-http-common/src/index.ts index 1c8d849c9cc68..8b146f699d126 100644 --- a/examples/routing_example/public/is_error.ts +++ b/packages/core/http/core-http-common/src/index.ts @@ -6,8 +6,4 @@ * Side Public License, v 1. */ -import { HttpFetchError } from '@kbn/core/public'; - -export function isError(error: T | HttpFetchError): error is HttpFetchError { - return error instanceof HttpFetchError; -} +export type { IExternalUrlPolicy } from './external_url_policy'; diff --git a/packages/core/http/core-http-common/tsconfig.json b/packages/core/http/core-http-common/tsconfig.json new file mode 100644 index 0000000000000..97a3644c3c703 --- /dev/null +++ b/packages/core/http/core-http-common/tsconfig.json @@ -0,0 +1,17 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/core/http/core-http-context-server-internal/BUILD.bazel b/packages/core/http/core-http-context-server-internal/BUILD.bazel new file mode 100644 index 0000000000000..f6d509a851f96 --- /dev/null +++ b/packages/core/http/core-http-context-server-internal/BUILD.bazel @@ -0,0 +1,104 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "core-http-context-server-internal" +PKG_REQUIRE_NAME = "@kbn/core-http-context-server-internal" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + ], + exclude = [ + "**/*.test.*", + "**/*.stories.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +RUNTIME_DEPS = [ + "@npm//lodash", +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", + "@npm//lodash", + "//packages/kbn-utility-types:npm_module_types", + "//packages/core/base/core-base-common:npm_module_types", + "//packages/core/base/core-base-common-internal:npm_module_types", + "//packages/core/base/core-base-server-internal:npm_module_types", + "//packages/core/http/core-http-server:npm_module_types", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + declaration_map = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/core/http/core-http-context-server-internal/README.md b/packages/core/http/core-http-context-server-internal/README.md new file mode 100644 index 0000000000000..8d1aced432ccd --- /dev/null +++ b/packages/core/http/core-http-context-server-internal/README.md @@ -0,0 +1,3 @@ +# @kbn/core-http-context-server-internal + +This package contains the internal types and implementation for Core's internal `http` context service. diff --git a/packages/core/http/core-http-context-server-internal/jest.config.js b/packages/core/http/core-http-context-server-internal/jest.config.js new file mode 100644 index 0000000000000..e6e2b030dc3a9 --- /dev/null +++ b/packages/core/http/core-http-context-server-internal/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test/jest_node', + rootDir: '../../../..', + roots: ['/packages/core/http/core-http-context-server-internal'], +}; diff --git a/packages/core/http/core-http-context-server-internal/package.json b/packages/core/http/core-http-context-server-internal/package.json new file mode 100644 index 0000000000000..1c2c18afb7da0 --- /dev/null +++ b/packages/core/http/core-http-context-server-internal/package.json @@ -0,0 +1,7 @@ +{ + "name": "@kbn/core-http-context-server-internal", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/src/core/server/context/context_container.test.ts b/packages/core/http/core-http-context-server-internal/src/context_container.test.ts similarity index 92% rename from src/core/server/context/context_container.test.ts rename to packages/core/http/core-http-context-server-internal/src/context_container.test.ts index 2959533cec509..3b61cfea99fc9 100644 --- a/src/core/server/context/context_container.test.ts +++ b/packages/core/http/core-http-context-server-internal/src/context_container.test.ts @@ -7,9 +7,12 @@ */ import type { PluginOpaqueId } from '@kbn/core-base-common'; -import type { RequestHandlerContextBase } from '@kbn/core-http-server'; +import type { + RequestHandlerContextBase, + KibanaRequest, + KibanaResponseFactory, +} from '@kbn/core-http-server'; import { ContextContainer } from './context_container'; -import { httpServerMock } from '../http/http_server.mocks'; const pluginA = Symbol('pluginA'); const pluginB = Symbol('pluginB'); @@ -35,6 +38,13 @@ interface MyContext extends RequestHandlerContextBase { type TestContext = T & RequestHandlerContextBase; +const createKibanaRequest = (): KibanaRequest => { + return {} as unknown as KibanaRequest; +}; +const createKibanaResponseFactory = (): KibanaResponseFactory => { + return {} as unknown as KibanaResponseFactory; +}; + describe('ContextContainer', () => { describe('registerContext', () => { it('throws an error if the same context is registered twice', () => { @@ -145,8 +155,8 @@ describe('ContextContainer', () => { }); const handler1 = contextContainer.createHandler(pluginC, rawHandler1); - const request = httpServerMock.createKibanaRequest(); - const response = httpServerMock.createResponseFactory(); + const request = createKibanaRequest(); + const response = createKibanaResponseFactory(); await handler1(request, response); expect(core1provider).not.toHaveBeenCalled(); @@ -188,8 +198,8 @@ describe('ContextContainer', () => { }); const handler1 = contextContainer.createHandler(pluginC, rawHandler1); - const request = httpServerMock.createKibanaRequest(); - const response = httpServerMock.createResponseFactory(); + const request = createKibanaRequest(); + const response = createKibanaResponseFactory(); await handler1(request, response); expect(core1provider).not.toHaveBeenCalled(); @@ -229,8 +239,8 @@ describe('ContextContainer', () => { }); const handler1 = contextContainer.createHandler(pluginC, rawHandler1); - const request = httpServerMock.createKibanaRequest(); - const response = httpServerMock.createResponseFactory(); + const request = createKibanaRequest(); + const response = createKibanaResponseFactory(); await handler1(request, response); expect(core1provider).not.toHaveBeenCalled(); @@ -271,8 +281,8 @@ describe('ContextContainer', () => { }); const handler1 = contextContainer.createHandler(pluginC, rawHandler1); - const request = httpServerMock.createKibanaRequest(); - const response = httpServerMock.createResponseFactory(); + const request = createKibanaRequest(); + const response = createKibanaResponseFactory(); await handler1(request, response); expect(core1provider).not.toHaveBeenCalled(); @@ -356,8 +366,8 @@ describe('ContextContainer', () => { const handler2 = contextContainer.createHandler(pluginD, rawHandler2); - const request = httpServerMock.createKibanaRequest(); - const response = httpServerMock.createResponseFactory(); + const request = createKibanaRequest(); + const response = createKibanaResponseFactory(); await handler1(request, response); await handler2(request, response); @@ -400,8 +410,8 @@ describe('ContextContainer', () => { }); const handler1 = contextContainer.createHandler(pluginB, rawHandler1); - const request = httpServerMock.createKibanaRequest(); - const response = httpServerMock.createResponseFactory(); + const request = createKibanaRequest(); + const response = createKibanaResponseFactory(); expect(await handler1(request, response)).toEqual('handler1'); expect(rawHandler1).toHaveBeenCalledWith(expect.any(Object), request, response); @@ -430,8 +440,8 @@ describe('ContextContainer', () => { }); const handler1 = contextContainer.createHandler(pluginA, rawHandler1); - const request = httpServerMock.createKibanaRequest(); - const response = httpServerMock.createResponseFactory(); + const request = createKibanaRequest(); + const response = createKibanaResponseFactory(); expect(await handler1(request, response)).toEqual('handler1'); // If no context is registered for pluginA, only core contexts should be exposed @@ -454,8 +464,8 @@ describe('ContextContainer', () => { }); const handler1 = contextContainer.createHandler(coreId, rawHandler1); - const request = httpServerMock.createKibanaRequest(); - const response = httpServerMock.createResponseFactory(); + const request = createKibanaRequest(); + const response = createKibanaResponseFactory(); expect(await handler1(request, response)).toEqual('handler1'); expect(rawHandler1).toHaveBeenCalledWith(expect.any(Object), request, response); @@ -465,8 +475,8 @@ describe('ContextContainer', () => { expect.assertions(7); const contextContainer = new ContextContainer(plugins, coreId); - const request = httpServerMock.createKibanaRequest(); - const response = httpServerMock.createResponseFactory(); + const request = createKibanaRequest(); + const response = createKibanaResponseFactory(); contextContainer.registerContext(coreId, 'core1', (context, req, res) => { expect(req).toBe(request); expect(res).toBe(response); @@ -567,8 +577,8 @@ describe('ContextContainer', () => { const handler2 = contextContainer.createHandler(pluginD, rawHandler2); - const request = httpServerMock.createKibanaRequest(); - const response = httpServerMock.createResponseFactory(); + const request = createKibanaRequest(); + const response = createKibanaResponseFactory(); await handler1(request, response); await handler2(request, response); @@ -597,8 +607,8 @@ describe('ContextContainer', () => { const rawHandler1 = jest.fn(() => 'handler1' as any); const handler1 = contextContainer.createHandler(pluginA, rawHandler1); - const request = httpServerMock.createKibanaRequest(); - const response = httpServerMock.createResponseFactory(); + const request = createKibanaRequest(); + const response = createKibanaResponseFactory(); expect(await handler1(request, response)).toEqual('handler1'); }); @@ -608,8 +618,8 @@ describe('ContextContainer', () => { const rawHandler1 = jest.fn(() => 'handler1' as any); const handler1 = contextContainer.createHandler(pluginA, rawHandler1); - const request = httpServerMock.createKibanaRequest(); - const response = httpServerMock.createResponseFactory(); + const request = createKibanaRequest(); + const response = createKibanaResponseFactory(); await handler1(request, response); expect(rawHandler1).toHaveBeenCalledWith( { resolve: expect.any(Function) }, diff --git a/src/core/server/context/context_container.ts b/packages/core/http/core-http-context-server-internal/src/context_container.ts similarity index 100% rename from src/core/server/context/context_container.ts rename to packages/core/http/core-http-context-server-internal/src/context_container.ts diff --git a/packages/core/http/core-http-context-server-internal/src/context_service.test.mocks.ts b/packages/core/http/core-http-context-server-internal/src/context_service.test.mocks.ts new file mode 100644 index 0000000000000..49d48f3424f16 --- /dev/null +++ b/packages/core/http/core-http-context-server-internal/src/context_service.test.mocks.ts @@ -0,0 +1,27 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { IContextContainer } from '@kbn/core-http-server'; + +const createContextMock = (mockContext: any = {}) => { + const contextMock: jest.Mocked = { + registerContext: jest.fn(), + createHandler: jest.fn(), + }; + contextMock.createHandler.mockImplementation( + (pluginId, handler) => + (...args) => + Promise.resolve(handler(mockContext, ...args)) + ); + return contextMock; +}; + +export const MockContextConstructor = jest.fn(createContextMock); +jest.doMock('./context_container', () => ({ + ContextContainer: MockContextConstructor, +})); diff --git a/src/core/server/context/context_service.test.ts b/packages/core/http/core-http-context-server-internal/src/context_service.test.ts similarity index 100% rename from src/core/server/context/context_service.test.ts rename to packages/core/http/core-http-context-server-internal/src/context_service.test.ts diff --git a/src/core/server/context/context_service.ts b/packages/core/http/core-http-context-server-internal/src/context_service.ts similarity index 100% rename from src/core/server/context/context_service.ts rename to packages/core/http/core-http-context-server-internal/src/context_service.ts diff --git a/src/core/server/context/index.ts b/packages/core/http/core-http-context-server-internal/src/index.ts similarity index 100% rename from src/core/server/context/index.ts rename to packages/core/http/core-http-context-server-internal/src/index.ts diff --git a/packages/core/http/core-http-context-server-internal/tsconfig.json b/packages/core/http/core-http-context-server-internal/tsconfig.json new file mode 100644 index 0000000000000..39d3c7097814a --- /dev/null +++ b/packages/core/http/core-http-context-server-internal/tsconfig.json @@ -0,0 +1,18 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "declarationMap": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/core/http/core-http-context-server-mocks/BUILD.bazel b/packages/core/http/core-http-context-server-mocks/BUILD.bazel new file mode 100644 index 0000000000000..a53bae874f6d9 --- /dev/null +++ b/packages/core/http/core-http-context-server-mocks/BUILD.bazel @@ -0,0 +1,100 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "core-http-context-server-mocks" +PKG_REQUIRE_NAME = "@kbn/core-http-context-server-mocks" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + ], + exclude = [ + "**/*.test.*", + "**/*.stories.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +RUNTIME_DEPS = [ +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", + "//packages/kbn-utility-types:npm_module_types", + "//packages/core/http/core-http-server:npm_module_types", + "//packages/core/http/core-http-context-server-internal:npm_module_types", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + declaration_map = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/core/http/core-http-context-server-mocks/README.md b/packages/core/http/core-http-context-server-mocks/README.md new file mode 100644 index 0000000000000..2be50f33660bc --- /dev/null +++ b/packages/core/http/core-http-context-server-mocks/README.md @@ -0,0 +1,3 @@ +# @kbn/core-http-context-server-mocks + +This package contains the mocks for Core's internal `http` context service. diff --git a/packages/core/http/core-http-context-server-mocks/jest.config.js b/packages/core/http/core-http-context-server-mocks/jest.config.js new file mode 100644 index 0000000000000..14c289e08adff --- /dev/null +++ b/packages/core/http/core-http-context-server-mocks/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test/jest_node', + rootDir: '../../../..', + roots: ['/packages/core/http/core-http-context-server-mocks'], +}; diff --git a/packages/core/http/core-http-context-server-mocks/package.json b/packages/core/http/core-http-context-server-mocks/package.json new file mode 100644 index 0000000000000..e98f7c35c3968 --- /dev/null +++ b/packages/core/http/core-http-context-server-mocks/package.json @@ -0,0 +1,7 @@ +{ + "name": "@kbn/core-http-context-server-mocks", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/src/core/server/context/context_container.mock.ts b/packages/core/http/core-http-context-server-mocks/src/context_container.mock.ts similarity index 100% rename from src/core/server/context/context_container.mock.ts rename to packages/core/http/core-http-context-server-mocks/src/context_container.mock.ts diff --git a/src/core/server/context/context_service.mock.ts b/packages/core/http/core-http-context-server-mocks/src/context_service.mock.ts similarity index 91% rename from src/core/server/context/context_service.mock.ts rename to packages/core/http/core-http-context-server-mocks/src/context_service.mock.ts index ca07e6c6923c2..6b56e43b35c76 100644 --- a/src/core/server/context/context_service.mock.ts +++ b/packages/core/http/core-http-context-server-mocks/src/context_service.mock.ts @@ -7,8 +7,11 @@ */ import type { PublicMethodsOf } from '@kbn/utility-types'; - -import { ContextService, InternalContextSetup, InternalContextPreboot } from './context_service'; +import type { + ContextService, + InternalContextSetup, + InternalContextPreboot, +} from '@kbn/core-http-context-server-internal'; import { contextMock } from './context_container.mock'; const createPrebootContractMock = (mockContext = {}) => { diff --git a/packages/core/http/core-http-context-server-mocks/src/index.ts b/packages/core/http/core-http-context-server-mocks/src/index.ts new file mode 100644 index 0000000000000..b58cc5d877bd9 --- /dev/null +++ b/packages/core/http/core-http-context-server-mocks/src/index.ts @@ -0,0 +1,11 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export type { ContextContainerMock } from './context_container.mock'; +export { contextMock } from './context_container.mock'; +export { contextServiceMock } from './context_service.mock'; diff --git a/packages/core/http/core-http-context-server-mocks/tsconfig.json b/packages/core/http/core-http-context-server-mocks/tsconfig.json new file mode 100644 index 0000000000000..39d3c7097814a --- /dev/null +++ b/packages/core/http/core-http-context-server-mocks/tsconfig.json @@ -0,0 +1,18 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "declarationMap": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/core/http/core-http-router-server-internal/BUILD.bazel b/packages/core/http/core-http-router-server-internal/BUILD.bazel new file mode 100644 index 0000000000000..016156539aaa2 --- /dev/null +++ b/packages/core/http/core-http-router-server-internal/BUILD.bazel @@ -0,0 +1,114 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "core-http-router-server-internal" +PKG_REQUIRE_NAME = "@kbn/core-http-router-server-internal" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + ], + exclude = [ + "**/*.test.*", + "**/*.stories.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +RUNTIME_DEPS = [ + "@npm//@hapi/boom", + "@npm//uuid", + "@npm//rxjs", + "@npm//type-detect", + "//packages/kbn-config-schema", + "//packages/kbn-es-errors", +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", + "@npm//@types/uuid", + "@npm//type-detect", + "@npm//@hapi/hapi", + "@npm//@types/hapi__hapi", + "@npm//@hapi/boom", + "@npm//rxjs", + "//packages/kbn-std:npm_module_types", + "//packages/kbn-utility-types:npm_module_types", + "//packages/kbn-config-schema:npm_module_types", + "//packages/kbn-es-errors:npm_module_types", + "//packages/core/http/core-http-server:npm_module_types", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + declaration_map = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/core/http/core-http-router-server-internal/README.md b/packages/core/http/core-http-router-server-internal/README.md new file mode 100644 index 0000000000000..5b8926822d460 --- /dev/null +++ b/packages/core/http/core-http-router-server-internal/README.md @@ -0,0 +1,4 @@ +# @kbn/core-http-router-server-internal + +This package contains the internal types and implementation for Core's internal `http` router sub-domain. + diff --git a/packages/core/http/core-http-router-server-internal/jest.config.js b/packages/core/http/core-http-router-server-internal/jest.config.js new file mode 100644 index 0000000000000..c0b4fc1497eed --- /dev/null +++ b/packages/core/http/core-http-router-server-internal/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test/jest_node', + rootDir: '../../../..', + roots: ['/packages/core/http/core-http-router-server-internal'], +}; diff --git a/packages/core/http/core-http-router-server-internal/package.json b/packages/core/http/core-http-router-server-internal/package.json new file mode 100644 index 0000000000000..45c10b39164b3 --- /dev/null +++ b/packages/core/http/core-http-router-server-internal/package.json @@ -0,0 +1,7 @@ +{ + "name": "@kbn/core-http-router-server-internal", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/src/core/server/http/router/error_wrapper.test.ts b/packages/core/http/core-http-router-server-internal/src/error_wrapper.test.ts similarity index 100% rename from src/core/server/http/router/error_wrapper.test.ts rename to packages/core/http/core-http-router-server-internal/src/error_wrapper.test.ts diff --git a/src/core/server/http/router/error_wrapper.ts b/packages/core/http/core-http-router-server-internal/src/error_wrapper.ts similarity index 100% rename from src/core/server/http/router/error_wrapper.ts rename to packages/core/http/core-http-router-server-internal/src/error_wrapper.ts diff --git a/src/core/server/http/router/headers.ts b/packages/core/http/core-http-router-server-internal/src/headers.ts similarity index 100% rename from src/core/server/http/router/headers.ts rename to packages/core/http/core-http-router-server-internal/src/headers.ts diff --git a/src/core/server/http/router/index.ts b/packages/core/http/core-http-router-server-internal/src/index.ts similarity index 100% rename from src/core/server/http/router/index.ts rename to packages/core/http/core-http-router-server-internal/src/index.ts diff --git a/src/core/server/http/router/request.test.ts b/packages/core/http/core-http-router-server-internal/src/request.test.ts similarity index 100% rename from src/core/server/http/router/request.test.ts rename to packages/core/http/core-http-router-server-internal/src/request.test.ts diff --git a/src/core/server/http/router/request.ts b/packages/core/http/core-http-router-server-internal/src/request.ts similarity index 99% rename from src/core/server/http/router/request.ts rename to packages/core/http/core-http-router-server-internal/src/request.ts index 39bc87679b7cd..49e764a50cc00 100644 --- a/src/core/server/http/router/request.ts +++ b/packages/core/http/core-http-router-server-internal/src/request.ts @@ -8,7 +8,7 @@ import { URL } from 'url'; import uuid from 'uuid'; -import { Request, RouteOptions } from '@hapi/hapi'; +import type { Request, RouteOptions } from '@hapi/hapi'; import { fromEvent, NEVER } from 'rxjs'; import { shareReplay, first, filter } from 'rxjs/operators'; import { RecursiveReadonly } from '@kbn/utility-types'; diff --git a/src/core/server/http/router/response.ts b/packages/core/http/core-http-router-server-internal/src/response.ts similarity index 100% rename from src/core/server/http/router/response.ts rename to packages/core/http/core-http-router-server-internal/src/response.ts diff --git a/src/core/server/http/router/response_adapter.ts b/packages/core/http/core-http-router-server-internal/src/response_adapter.ts similarity index 100% rename from src/core/server/http/router/response_adapter.ts rename to packages/core/http/core-http-router-server-internal/src/response_adapter.ts diff --git a/src/core/server/http/router/route.ts b/packages/core/http/core-http-router-server-internal/src/route.ts similarity index 100% rename from src/core/server/http/router/route.ts rename to packages/core/http/core-http-router-server-internal/src/route.ts diff --git a/src/core/server/http/router/router.test.ts b/packages/core/http/core-http-router-server-internal/src/router.test.ts similarity index 100% rename from src/core/server/http/router/router.test.ts rename to packages/core/http/core-http-router-server-internal/src/router.test.ts diff --git a/src/core/server/http/router/router.ts b/packages/core/http/core-http-router-server-internal/src/router.ts similarity index 100% rename from src/core/server/http/router/router.ts rename to packages/core/http/core-http-router-server-internal/src/router.ts diff --git a/src/core/server/http/router/socket.test.ts b/packages/core/http/core-http-router-server-internal/src/socket.test.ts similarity index 100% rename from src/core/server/http/router/socket.test.ts rename to packages/core/http/core-http-router-server-internal/src/socket.test.ts diff --git a/src/core/server/http/router/socket.ts b/packages/core/http/core-http-router-server-internal/src/socket.ts similarity index 100% rename from src/core/server/http/router/socket.ts rename to packages/core/http/core-http-router-server-internal/src/socket.ts diff --git a/src/core/server/http/router/validator.test.ts b/packages/core/http/core-http-router-server-internal/src/validator.test.ts similarity index 100% rename from src/core/server/http/router/validator.test.ts rename to packages/core/http/core-http-router-server-internal/src/validator.test.ts diff --git a/src/core/server/http/router/validator.ts b/packages/core/http/core-http-router-server-internal/src/validator.ts similarity index 100% rename from src/core/server/http/router/validator.ts rename to packages/core/http/core-http-router-server-internal/src/validator.ts diff --git a/packages/core/http/core-http-router-server-internal/tsconfig.json b/packages/core/http/core-http-router-server-internal/tsconfig.json new file mode 100644 index 0000000000000..39d3c7097814a --- /dev/null +++ b/packages/core/http/core-http-router-server-internal/tsconfig.json @@ -0,0 +1,18 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "declarationMap": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/core/http/core-http-router-server-mocks/BUILD.bazel b/packages/core/http/core-http-router-server-mocks/BUILD.bazel new file mode 100644 index 0000000000000..a377948e772ef --- /dev/null +++ b/packages/core/http/core-http-router-server-mocks/BUILD.bazel @@ -0,0 +1,106 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "core-http-router-server-mocks" +PKG_REQUIRE_NAME = "@kbn/core-http-router-server-mocks" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + ], + exclude = [ + "**/*.test.*", + "**/*.stories.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +RUNTIME_DEPS = [ + "@npm//query-string", + "//packages/kbn-hapi-mocks", + "//packages/kbn-config-schema", + "//packages/core/http/core-http-router-server-internal", +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", + "@npm//query-string", + "//packages/kbn-hapi-mocks:npm_module_types", + "//packages/kbn-config-schema:npm_module_types", + "//packages/core/http/core-http-server:npm_module_types", + "//packages/core/http/core-http-router-server-internal:npm_module_types", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + declaration_map = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/core/http/core-http-router-server-mocks/README.md b/packages/core/http/core-http-router-server-mocks/README.md new file mode 100644 index 0000000000000..87bb78da4dfdc --- /dev/null +++ b/packages/core/http/core-http-router-server-mocks/README.md @@ -0,0 +1,3 @@ +# @kbn/core-http-router-server-mocks + +This package contains the mocks for Core's internal `http` router sub-domain. diff --git a/packages/core/http/core-http-router-server-mocks/jest.config.js b/packages/core/http/core-http-router-server-mocks/jest.config.js new file mode 100644 index 0000000000000..7f154d49c62ea --- /dev/null +++ b/packages/core/http/core-http-router-server-mocks/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test/jest_node', + rootDir: '../../../..', + roots: ['/packages/core/http/core-http-router-server-mocks'], +}; diff --git a/packages/core/http/core-http-router-server-mocks/package.json b/packages/core/http/core-http-router-server-mocks/package.json new file mode 100644 index 0000000000000..59c910af29012 --- /dev/null +++ b/packages/core/http/core-http-router-server-mocks/package.json @@ -0,0 +1,7 @@ +{ + "name": "@kbn/core-http-router-server-mocks", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/packages/core/http/core-http-router-server-mocks/src/index.ts b/packages/core/http/core-http-router-server-mocks/src/index.ts new file mode 100644 index 0000000000000..8f04fc362edfa --- /dev/null +++ b/packages/core/http/core-http-router-server-mocks/src/index.ts @@ -0,0 +1,10 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export { mockRouter } from './router.mock'; +export type { RouterMock, RequestFixtureOptions } from './router.mock'; diff --git a/src/core/server/http/router/router.mock.ts b/packages/core/http/core-http-router-server-mocks/src/router.mock.ts similarity index 98% rename from src/core/server/http/router/router.mock.ts rename to packages/core/http/core-http-router-server-mocks/src/router.mock.ts index 573d43fea80d5..c6e2deb9b1473 100644 --- a/src/core/server/http/router/router.mock.ts +++ b/packages/core/http/core-http-router-server-mocks/src/router.mock.ts @@ -20,7 +20,7 @@ import type { KibanaRequestState, KibanaResponseFactory, } from '@kbn/core-http-server'; -import { CoreKibanaRequest } from './request'; +import { CoreKibanaRequest } from '@kbn/core-http-router-server-internal'; export type RouterMock = jest.Mocked>; diff --git a/packages/core/http/core-http-router-server-mocks/tsconfig.json b/packages/core/http/core-http-router-server-mocks/tsconfig.json new file mode 100644 index 0000000000000..39d3c7097814a --- /dev/null +++ b/packages/core/http/core-http-router-server-mocks/tsconfig.json @@ -0,0 +1,18 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "declarationMap": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/core/http/core-http-server-internal/BUILD.bazel b/packages/core/http/core-http-server-internal/BUILD.bazel new file mode 100644 index 0000000000000..b61ca9d0493c9 --- /dev/null +++ b/packages/core/http/core-http-server-internal/BUILD.bazel @@ -0,0 +1,146 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "core-http-server-internal" +PKG_REQUIRE_NAME = "@kbn/core-http-server-internal" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + ], + exclude = [ + "**/*.test.*", + "**/*.stories.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +RUNTIME_DEPS = [ + "@npm//lodash", + "@npm//rxjs", + "@npm//uuid", + "@npm//moment", + "@npm//@elastic/numeral", + "@npm//@hapi/boom", + "@npm//@hapi/cookie", + "@npm//@hapi/inert", + "@npm//elastic-apm-node", + "//packages/kbn-utils", + "//packages/kbn-std", + "//packages/kbn-config-schema", + "//packages/kbn-logging", + "//packages/kbn-crypto", + "//packages/kbn-server-http-tools", + "//packages/core/http/core-http-router-server-internal", + ### test dependencies + "@npm//supertest", + "@npm//chance", + "//packages/kbn-hapi-mocks", + "//packages/core/http/core-http-router-server-mocks", + "//packages/core/logging/core-logging-server-mocks", + "//packages/core/http/core-http-context-server-mocks", +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", + "@npm//@types/uuid", + "@npm//rxjs", + "@npm//moment", + "@npm//@elastic/numeral", + "@npm//lodash", + "@npm//@hapi/hapi", + "@npm//@hapi/boom", + "@npm//@hapi/cookie", + "@npm//@hapi/inert", + "@npm//@types/hapi__hapi", + "@npm//@types/hapi__cookie", + "@npm//@types/hapi__inert", + "@npm//elastic-apm-node", + "//packages/kbn-utils:npm_module_types", + "//packages/kbn-std:npm_module_types", + "//packages/kbn-server-http-tools:npm_module_types", + "//packages/kbn-logging:npm_module_types", + "//packages/kbn-config-schema:npm_module_types", + "//packages/kbn-crypto:npm_module_types", + "//packages/core/base/core-base-common:npm_module_types", + "//packages/core/base/core-base-server-internal:npm_module_types", + "//packages/core/execution-context/core-execution-context-server-internal:npm_module_types", + "//packages/core/http/core-http-common:npm_module_types", + "//packages/core/http/core-http-server:npm_module_types", + "//packages/core/http/core-http-context-server-internal:npm_module_types", + "//packages/core/http/core-http-router-server-internal:npm_module_types", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + declaration_map = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/core/http/core-http-server-internal/README.md b/packages/core/http/core-http-server-internal/README.md new file mode 100644 index 0000000000000..e47cd5456ec28 --- /dev/null +++ b/packages/core/http/core-http-server-internal/README.md @@ -0,0 +1,3 @@ +# @kbn/core-http-server-internal + +This package contains the internal types and implementation for core's server-side `http` service diff --git a/packages/core/http/core-http-server-internal/jest.config.js b/packages/core/http/core-http-server-internal/jest.config.js new file mode 100644 index 0000000000000..6938210c126ed --- /dev/null +++ b/packages/core/http/core-http-server-internal/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test/jest_node', + rootDir: '../../../..', + roots: ['/packages/core/http/core-http-server-internal'], +}; diff --git a/packages/core/http/core-http-server-internal/package.json b/packages/core/http/core-http-server-internal/package.json new file mode 100644 index 0000000000000..af6db3d6b5106 --- /dev/null +++ b/packages/core/http/core-http-server-internal/package.json @@ -0,0 +1,7 @@ +{ + "name": "@kbn/core-http-server-internal", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/packages/core/http/core-http-server-internal/src/__fixtures/static/compression_available.json b/packages/core/http/core-http-server-internal/src/__fixtures/static/compression_available.json new file mode 100644 index 0000000000000..1f878fb465cff --- /dev/null +++ b/packages/core/http/core-http-server-internal/src/__fixtures/static/compression_available.json @@ -0,0 +1,3 @@ +{ + "hello": "dolly" +} diff --git a/packages/core/http/core-http-server-internal/src/__fixtures/static/compression_available.json.gz b/packages/core/http/core-http-server-internal/src/__fixtures/static/compression_available.json.gz new file mode 100644 index 0000000000000..e77819d2e8e59 Binary files /dev/null and b/packages/core/http/core-http-server-internal/src/__fixtures/static/compression_available.json.gz differ diff --git a/packages/core/http/core-http-server-internal/src/__fixtures/static/some_json.json b/packages/core/http/core-http-server-internal/src/__fixtures/static/some_json.json new file mode 100644 index 0000000000000..c8c4105eb57cd --- /dev/null +++ b/packages/core/http/core-http-server-internal/src/__fixtures/static/some_json.json @@ -0,0 +1,3 @@ +{ + "foo": "bar" +} diff --git a/src/core/server/http/__snapshots__/http_config.test.ts.snap b/packages/core/http/core-http-server-internal/src/__snapshots__/http_config.test.ts.snap similarity index 100% rename from src/core/server/http/__snapshots__/http_config.test.ts.snap rename to packages/core/http/core-http-server-internal/src/__snapshots__/http_config.test.ts.snap diff --git a/src/core/server/http/__snapshots__/http_service.test.ts.snap b/packages/core/http/core-http-server-internal/src/__snapshots__/http_service.test.ts.snap similarity index 100% rename from src/core/server/http/__snapshots__/http_service.test.ts.snap rename to packages/core/http/core-http-server-internal/src/__snapshots__/http_service.test.ts.snap diff --git a/src/core/server/http/__snapshots__/https_redirect_server.test.ts.snap b/packages/core/http/core-http-server-internal/src/__snapshots__/https_redirect_server.test.ts.snap similarity index 100% rename from src/core/server/http/__snapshots__/https_redirect_server.test.ts.snap rename to packages/core/http/core-http-server-internal/src/__snapshots__/https_redirect_server.test.ts.snap diff --git a/src/core/server/http/auth_headers_storage.test.ts b/packages/core/http/core-http-server-internal/src/auth_headers_storage.test.ts similarity index 86% rename from src/core/server/http/auth_headers_storage.test.ts rename to packages/core/http/core-http-server-internal/src/auth_headers_storage.test.ts index b00fcaa0a1854..6d150f47b682d 100644 --- a/src/core/server/http/auth_headers_storage.test.ts +++ b/packages/core/http/core-http-server-internal/src/auth_headers_storage.test.ts @@ -7,14 +7,14 @@ */ import { AuthHeadersStorage } from './auth_headers_storage'; -import { httpServerMock } from './http_server.mocks'; +import { mockRouter } from '@kbn/core-http-router-server-mocks'; describe('AuthHeadersStorage', () => { describe('stores authorization headers', () => { it('retrieves a copy of headers associated with Kibana request', () => { const headers = { authorization: 'token' }; const storage = new AuthHeadersStorage(); - const request = httpServerMock.createKibanaRequest(); + const request = mockRouter.createKibanaRequest(); storage.set(request, headers); expect(storage.get(request)).toEqual(headers); }); diff --git a/src/core/server/http/auth_headers_storage.ts b/packages/core/http/core-http-server-internal/src/auth_headers_storage.ts similarity index 92% rename from src/core/server/http/auth_headers_storage.ts rename to packages/core/http/core-http-server-internal/src/auth_headers_storage.ts index 58f1086b7533f..1138187191309 100644 --- a/src/core/server/http/auth_headers_storage.ts +++ b/packages/core/http/core-http-server-internal/src/auth_headers_storage.ts @@ -13,7 +13,7 @@ import type { IAuthHeadersStorage, GetAuthHeaders, } from '@kbn/core-http-server'; -import { ensureRawRequest } from './router'; +import { ensureRawRequest } from '@kbn/core-http-router-server-internal'; /** @internal */ export class AuthHeadersStorage implements IAuthHeadersStorage { diff --git a/src/core/server/http/auth_state_storage.ts b/packages/core/http/core-http-server-internal/src/auth_state_storage.ts similarity index 94% rename from src/core/server/http/auth_state_storage.ts rename to packages/core/http/core-http-server-internal/src/auth_state_storage.ts index d305cf18ce60b..7bdb78db8ce54 100644 --- a/src/core/server/http/auth_state_storage.ts +++ b/packages/core/http/core-http-server-internal/src/auth_state_storage.ts @@ -5,10 +5,11 @@ * in compliance with, at your election, the Elastic License 2.0 or the Server * Side Public License, v 1. */ + import { Request } from '@hapi/hapi'; import type { KibanaRequest, IsAuthenticated } from '@kbn/core-http-server'; import { AuthStatus } from '@kbn/core-http-server'; -import { ensureRawRequest } from './router'; +import { ensureRawRequest } from '@kbn/core-http-router-server-internal'; /** @internal */ export class AuthStateStorage { diff --git a/src/core/server/http/base_path_service.test.ts b/packages/core/http/core-http-server-internal/src/base_path_service.test.ts similarity index 94% rename from src/core/server/http/base_path_service.test.ts rename to packages/core/http/core-http-server-internal/src/base_path_service.test.ts index 2d26000b4672b..efeb61b72c9ae 100644 --- a/src/core/server/http/base_path_service.test.ts +++ b/packages/core/http/core-http-server-internal/src/base_path_service.test.ts @@ -6,8 +6,8 @@ * Side Public License, v 1. */ +import { mockRouter } from '@kbn/core-http-router-server-mocks'; import { BasePath } from './base_path_service'; -import { httpServerMock } from './http_server.mocks'; describe('BasePath', () => { describe('serverBasePath', () => { @@ -36,7 +36,7 @@ describe('BasePath', () => { describe('#get()', () => { it('returns base path associated with an incoming KibanaRequest', () => { - const request = httpServerMock.createKibanaRequest(); + const request = mockRouter.createKibanaRequest(); const basePath = new BasePath(); basePath.set(request, '/baz/'); @@ -44,7 +44,7 @@ describe('BasePath', () => { }); it('is based on server base path', () => { - const request = httpServerMock.createKibanaRequest(); + const request = mockRouter.createKibanaRequest(); const basePath = new BasePath('/foo/bar'); basePath.set(request, '/baz/'); @@ -54,7 +54,7 @@ describe('BasePath', () => { describe('#set()', () => { it('#set() cannot be set twice for one request', () => { - const request = httpServerMock.createKibanaRequest(); + const request = mockRouter.createKibanaRequest(); const basePath = new BasePath('/foo/bar'); const setPath = () => basePath.set(request, 'baz/'); diff --git a/src/core/server/http/base_path_service.ts b/packages/core/http/core-http-server-internal/src/base_path_service.ts similarity index 96% rename from src/core/server/http/base_path_service.ts rename to packages/core/http/core-http-server-internal/src/base_path_service.ts index e5d5e164a4c9d..cd40fc57399af 100644 --- a/src/core/server/http/base_path_service.ts +++ b/packages/core/http/core-http-server-internal/src/base_path_service.ts @@ -9,7 +9,7 @@ import { modifyUrl } from '@kbn/std'; import { Request } from '@hapi/hapi'; import type { KibanaRequest, IBasePath } from '@kbn/core-http-server'; -import { ensureRawRequest } from './router'; +import { ensureRawRequest } from '@kbn/core-http-router-server-internal'; /** * Core internal implementation of {@link IBasePath} diff --git a/src/core/server/http/cookie_session_storage.ts b/packages/core/http/core-http-server-internal/src/cookie_session_storage.ts similarity index 98% rename from src/core/server/http/cookie_session_storage.ts rename to packages/core/http/core-http-server-internal/src/cookie_session_storage.ts index 63975ab549b06..bba5a9742edb6 100644 --- a/src/core/server/http/cookie_session_storage.ts +++ b/packages/core/http/core-http-server-internal/src/cookie_session_storage.ts @@ -16,7 +16,7 @@ import type { SessionStorage, SessionStorageCookieOptions, } from '@kbn/core-http-server'; -import { ensureRawRequest } from './router'; +import { ensureRawRequest } from '@kbn/core-http-router-server-internal'; class ScopedCookieSessionStorage> implements SessionStorage { constructor( diff --git a/src/core/server/http/csp/config.test.ts b/packages/core/http/core-http-server-internal/src/csp/config.test.ts similarity index 100% rename from src/core/server/http/csp/config.test.ts rename to packages/core/http/core-http-server-internal/src/csp/config.test.ts diff --git a/src/core/server/http/csp/config.ts b/packages/core/http/core-http-server-internal/src/csp/config.ts similarity index 100% rename from src/core/server/http/csp/config.ts rename to packages/core/http/core-http-server-internal/src/csp/config.ts diff --git a/src/core/server/http/csp/csp_config.test.mocks.ts b/packages/core/http/core-http-server-internal/src/csp/csp_config.test.mocks.ts similarity index 100% rename from src/core/server/http/csp/csp_config.test.mocks.ts rename to packages/core/http/core-http-server-internal/src/csp/csp_config.test.mocks.ts diff --git a/src/core/server/http/csp/csp_config.test.ts b/packages/core/http/core-http-server-internal/src/csp/csp_config.test.ts similarity index 100% rename from src/core/server/http/csp/csp_config.test.ts rename to packages/core/http/core-http-server-internal/src/csp/csp_config.test.ts diff --git a/src/core/server/http/csp/csp_config.ts b/packages/core/http/core-http-server-internal/src/csp/csp_config.ts similarity index 100% rename from src/core/server/http/csp/csp_config.ts rename to packages/core/http/core-http-server-internal/src/csp/csp_config.ts diff --git a/src/core/server/http/csp/csp_directives.test.ts b/packages/core/http/core-http-server-internal/src/csp/csp_directives.test.ts similarity index 100% rename from src/core/server/http/csp/csp_directives.test.ts rename to packages/core/http/core-http-server-internal/src/csp/csp_directives.test.ts diff --git a/src/core/server/http/csp/csp_directives.ts b/packages/core/http/core-http-server-internal/src/csp/csp_directives.ts similarity index 100% rename from src/core/server/http/csp/csp_directives.ts rename to packages/core/http/core-http-server-internal/src/csp/csp_directives.ts diff --git a/src/core/server/http/csp/index.ts b/packages/core/http/core-http-server-internal/src/csp/index.ts similarity index 100% rename from src/core/server/http/csp/index.ts rename to packages/core/http/core-http-server-internal/src/csp/index.ts diff --git a/src/core/server/http/external_url/config.test.ts b/packages/core/http/core-http-server-internal/src/external_url/config.test.ts similarity index 100% rename from src/core/server/http/external_url/config.test.ts rename to packages/core/http/core-http-server-internal/src/external_url/config.test.ts diff --git a/src/core/server/http/external_url/config.ts b/packages/core/http/core-http-server-internal/src/external_url/config.ts similarity index 95% rename from src/core/server/http/external_url/config.ts rename to packages/core/http/core-http-server-internal/src/external_url/config.ts index fff38af0a97c6..5903257aa69a0 100644 --- a/src/core/server/http/external_url/config.ts +++ b/packages/core/http/core-http-server-internal/src/external_url/config.ts @@ -8,7 +8,7 @@ import { TypeOf, schema } from '@kbn/config-schema'; import type { ServiceConfigDescriptor } from '@kbn/core-base-server-internal'; -import type { IExternalUrlPolicy } from '@kbn/core-http-server'; +import type { IExternalUrlPolicy } from '@kbn/core-http-common'; /** * @internal diff --git a/src/core/server/http/external_url/external_url_config.ts b/packages/core/http/core-http-server-internal/src/external_url/external_url_config.ts similarity index 91% rename from src/core/server/http/external_url/external_url_config.ts rename to packages/core/http/core-http-server-internal/src/external_url/external_url_config.ts index 81addcc76fcd2..68364ebfd29ec 100644 --- a/src/core/server/http/external_url/external_url_config.ts +++ b/packages/core/http/core-http-server-internal/src/external_url/external_url_config.ts @@ -7,7 +7,8 @@ */ import { createSHA256Hash } from '@kbn/crypto'; -import type { IExternalUrlPolicy, IExternalUrlConfig } from '@kbn/core-http-server'; +import type { IExternalUrlPolicy } from '@kbn/core-http-common'; +import type { IExternalUrlConfig } from '@kbn/core-http-server'; import { externalUrlConfig } from './config'; const DEFAULT_CONFIG = Object.freeze(externalUrlConfig.schema.validate({})); diff --git a/src/core/server/http/external_url/index.ts b/packages/core/http/core-http-server-internal/src/external_url/index.ts similarity index 100% rename from src/core/server/http/external_url/index.ts rename to packages/core/http/core-http-server-internal/src/external_url/index.ts diff --git a/src/core/server/http/http_config.test.ts b/packages/core/http/core-http-server-internal/src/http_config.test.ts similarity index 100% rename from src/core/server/http/http_config.test.ts rename to packages/core/http/core-http-server-internal/src/http_config.test.ts diff --git a/src/core/server/http/http_config.ts b/packages/core/http/core-http-server-internal/src/http_config.ts similarity index 100% rename from src/core/server/http/http_config.ts rename to packages/core/http/core-http-server-internal/src/http_config.ts diff --git a/src/core/server/http/http_server.test.ts b/packages/core/http/core-http-server-internal/src/http_server.test.ts similarity index 99% rename from src/core/server/http/http_server.test.ts rename to packages/core/http/core-http-server-internal/src/http_server.test.ts index 4d55e82cfcb14..82debfa44c2cb 100644 --- a/src/core/server/http/http_server.test.ts +++ b/packages/core/http/core-http-server-internal/src/http_server.test.ts @@ -22,8 +22,8 @@ import type { RouteValidationFunction, RequestHandlerContextBase, } from '@kbn/core-http-server'; +import { Router } from '@kbn/core-http-router-server-internal'; import { HttpConfig } from './http_config'; -import { Router } from './router'; import { HttpServer } from './http_server'; import { Readable } from 'stream'; import { KBN_CERT_PATH, KBN_KEY_PATH } from '@kbn/dev-utils'; @@ -1410,7 +1410,7 @@ describe('setup contract', () => { }); describe('#registerStaticDir', () => { - const assetFolder = join(__dirname, 'integration_tests', 'fixtures', 'static'); + const assetFolder = join(__dirname, '__fixtures', 'static'); let tempDir: string; beforeAll(async () => { diff --git a/src/core/server/http/http_server.ts b/packages/core/http/core-http-server-internal/src/http_server.ts similarity index 99% rename from src/core/server/http/http_server.ts rename to packages/core/http/core-http-server-internal/src/http_server.ts index d5564e302c5af..766fa131349e1 100644 --- a/src/core/server/http/http_server.ts +++ b/packages/core/http/core-http-server-internal/src/http_server.ts @@ -16,7 +16,6 @@ import { getServerOptions, getRequestId, } from '@kbn/server-http-tools'; -import agent from 'elastic-apm-node'; import type { Duration } from 'moment'; import { firstValueFrom, Observable } from 'rxjs'; @@ -24,6 +23,7 @@ import { take } from 'rxjs/operators'; import apm from 'elastic-apm-node'; import type { Logger, LoggerFactory } from '@kbn/logging'; import type { InternalExecutionContextSetup } from '@kbn/core-execution-context-server-internal'; +import { isSafeMethod } from '@kbn/core-http-router-server-internal'; import type { IRouter, RouteConfigOptions, @@ -47,7 +47,6 @@ import { adoptToHapiOnPreAuth } from './lifecycle/on_pre_auth'; import { adoptToHapiOnPostAuthFormat } from './lifecycle/on_post_auth'; import { adoptToHapiOnRequest } from './lifecycle/on_pre_routing'; import { adoptToHapiOnPreResponseFormat } from './lifecycle/on_pre_response'; -import { isSafeMethod } from './router'; import { createCookieSessionStorageFactory } from './cookie_session_storage'; import { AuthStateStorage } from './auth_state_storage'; import { AuthHeadersStorage } from './auth_headers_storage'; @@ -359,7 +358,7 @@ export class HttpServer { requestUuid: uuid.v4(), // Kibana stores trace.id until https://github.com/elastic/apm-agent-nodejs/issues/2353 is resolved // The current implementation of the APM agent ends a request transaction before "response" log is emitted. - traceId: agent.currentTraceIds['trace.id'], + traceId: apm.currentTraceIds['trace.id'], } as KibanaRequestState; return responseToolkit.continue; }); diff --git a/src/core/server/http/http_service.test.mocks.ts b/packages/core/http/core-http-server-internal/src/http_service.test.mocks.ts similarity index 100% rename from src/core/server/http/http_service.test.mocks.ts rename to packages/core/http/core-http-server-internal/src/http_service.test.mocks.ts diff --git a/src/core/server/http/http_service.test.ts b/packages/core/http/core-http-server-internal/src/http_service.test.ts similarity index 98% rename from src/core/server/http/http_service.test.ts rename to packages/core/http/core-http-server-internal/src/http_service.test.ts index 2f4094edd4f82..8201560c935df 100644 --- a/src/core/server/http/http_service.test.ts +++ b/packages/core/http/core-http-server-internal/src/http_service.test.ts @@ -16,12 +16,12 @@ import { ConfigService, Env } from '@kbn/config'; import { getEnvOptions } from '@kbn/config-mocks'; import { loggingSystemMock } from '@kbn/core-logging-server-mocks'; import { executionContextServiceMock } from '@kbn/core-execution-context-server-mocks'; -import { HttpService } from '.'; +import { contextServiceMock } from '@kbn/core-http-context-server-mocks'; +import { Router } from '@kbn/core-http-router-server-internal'; +import { HttpService } from './http_service'; import { HttpConfigType, config } from './http_config'; -import { contextServiceMock } from '../context/context_service.mock'; import { cspConfig } from './csp'; import { externalUrlConfig, ExternalUrlConfig } from './external_url'; -import { Router } from './router'; const logger = loggingSystemMock.create(); const env = Env.createDefault(REPO_ROOT, getEnvOptions()); diff --git a/src/core/server/http/http_service.ts b/packages/core/http/core-http-server-internal/src/http_service.ts similarity index 97% rename from src/core/server/http/http_service.ts rename to packages/core/http/core-http-server-internal/src/http_service.ts index 0ef2c9d91af67..607413dcfd546 100644 --- a/src/core/server/http/http_service.ts +++ b/packages/core/http/core-http-server-internal/src/http_service.ts @@ -21,21 +21,21 @@ import type { IContextContainer, IContextProvider, } from '@kbn/core-http-server'; +import type { + InternalContextSetup, + InternalContextPreboot, +} from '@kbn/core-http-context-server-internal'; +import { Router } from '@kbn/core-http-router-server-internal'; -import { InternalContextSetup, InternalContextPreboot } from '../context'; import { CspConfigType, cspConfig } from './csp'; - -import { Router } from './router'; import { HttpConfig, HttpConfigType, config as httpConfig } from './http_config'; import { HttpServer } from './http_server'; import { HttpsRedirectServer } from './https_redirect_server'; - import { InternalHttpServicePreboot, InternalHttpServiceSetup, InternalHttpServiceStart, } from './types'; - import { registerCoreHandlers } from './lifecycle_handlers'; import { ExternalUrlConfigType, externalUrlConfig, ExternalUrlConfig } from './external_url'; diff --git a/src/core/server/http/https_redirect_server.test.ts b/packages/core/http/core-http-server-internal/src/https_redirect_server.test.ts similarity index 100% rename from src/core/server/http/https_redirect_server.test.ts rename to packages/core/http/core-http-server-internal/src/https_redirect_server.test.ts diff --git a/src/core/server/http/https_redirect_server.ts b/packages/core/http/core-http-server-internal/src/https_redirect_server.ts similarity index 100% rename from src/core/server/http/https_redirect_server.ts rename to packages/core/http/core-http-server-internal/src/https_redirect_server.ts diff --git a/src/core/server/http/index.ts b/packages/core/http/core-http-server-internal/src/index.ts similarity index 80% rename from src/core/server/http/index.ts rename to packages/core/http/core-http-server-internal/src/index.ts index 4e4f7938c1211..0c0abe4c989e5 100644 --- a/src/core/server/http/index.ts +++ b/packages/core/http/core-http-server-internal/src/index.ts @@ -9,7 +9,8 @@ export { config, HttpConfig } from './http_config'; export type { HttpConfigType } from './http_config'; export { HttpService } from './http_service'; -export { isKibanaRequest, isRealRequest, CoreKibanaRequest, kibanaResponseFactory } from './router'; +export { HttpServer } from './http_server'; +export type { HttpServerSetup, LifecycleRegistrar } from './http_server'; export type { InternalHttpServicePreboot, InternalHttpServiceSetup, @@ -20,3 +21,5 @@ export { BasePath } from './base_path_service'; export { cspConfig, CspConfig } from './csp'; export { externalUrlConfig, ExternalUrlConfig } from './external_url'; + +export { createCookieSessionStorageFactory } from './cookie_session_storage'; diff --git a/src/core/server/http/lifecycle/auth.ts b/packages/core/http/core-http-server-internal/src/lifecycle/auth.ts similarity index 96% rename from src/core/server/http/lifecycle/auth.ts rename to packages/core/http/core-http-server-internal/src/lifecycle/auth.ts index 6e6e4958904e1..b31c1805604d1 100644 --- a/src/core/server/http/lifecycle/auth.ts +++ b/packages/core/http/core-http-server-internal/src/lifecycle/auth.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { Lifecycle, Request, ResponseToolkit } from '@hapi/hapi'; +import type { Lifecycle, Request, ResponseToolkit } from '@hapi/hapi'; import type { Logger } from '@kbn/logging'; import type { AuthenticationHandler, @@ -24,7 +24,7 @@ import { CoreKibanaRequest, lifecycleResponseFactory, isKibanaResponse, -} from '../router'; +} from '@kbn/core-http-router-server-internal'; const authResult = { authenticated(data: AuthResultParams = {}): AuthResult { diff --git a/src/core/server/http/lifecycle/on_post_auth.ts b/packages/core/http/core-http-server-internal/src/lifecycle/on_post_auth.ts similarity index 97% rename from src/core/server/http/lifecycle/on_post_auth.ts rename to packages/core/http/core-http-server-internal/src/lifecycle/on_post_auth.ts index ff594aad9e827..22ef9db2bab08 100644 --- a/src/core/server/http/lifecycle/on_post_auth.ts +++ b/packages/core/http/core-http-server-internal/src/lifecycle/on_post_auth.ts @@ -20,7 +20,7 @@ import { CoreKibanaRequest, lifecycleResponseFactory, isKibanaResponse, -} from '../router'; +} from '@kbn/core-http-router-server-internal'; const postAuthResult = { next(): OnPostAuthResult { diff --git a/src/core/server/http/lifecycle/on_pre_auth.ts b/packages/core/http/core-http-server-internal/src/lifecycle/on_pre_auth.ts similarity index 97% rename from src/core/server/http/lifecycle/on_pre_auth.ts rename to packages/core/http/core-http-server-internal/src/lifecycle/on_pre_auth.ts index eda8034677192..67c12ca570191 100644 --- a/src/core/server/http/lifecycle/on_pre_auth.ts +++ b/packages/core/http/core-http-server-internal/src/lifecycle/on_pre_auth.ts @@ -20,7 +20,7 @@ import { CoreKibanaRequest, isKibanaResponse, lifecycleResponseFactory, -} from '../router'; +} from '@kbn/core-http-router-server-internal'; const preAuthResult = { next(): OnPreAuthResult { diff --git a/src/core/server/http/lifecycle/on_pre_response.ts b/packages/core/http/core-http-server-internal/src/lifecycle/on_pre_response.ts similarity index 98% rename from src/core/server/http/lifecycle/on_pre_response.ts rename to packages/core/http/core-http-server-internal/src/lifecycle/on_pre_response.ts index f5a473205284f..3a59d116a031d 100644 --- a/src/core/server/http/lifecycle/on_pre_response.ts +++ b/packages/core/http/core-http-server-internal/src/lifecycle/on_pre_response.ts @@ -25,7 +25,7 @@ import type { OnPreResponseHandler, } from '@kbn/core-http-server'; import { OnPreResponseResultType } from '@kbn/core-http-server'; -import { HapiResponseAdapter, CoreKibanaRequest } from '../router'; +import { HapiResponseAdapter, CoreKibanaRequest } from '@kbn/core-http-router-server-internal'; const preResponseResult = { render(responseRender: OnPreResponseRender): OnPreResponseResult { diff --git a/src/core/server/http/lifecycle/on_pre_routing.ts b/packages/core/http/core-http-server-internal/src/lifecycle/on_pre_routing.ts similarity index 98% rename from src/core/server/http/lifecycle/on_pre_routing.ts rename to packages/core/http/core-http-server-internal/src/lifecycle/on_pre_routing.ts index d5e16989cc833..36be4a61cc381 100644 --- a/src/core/server/http/lifecycle/on_pre_routing.ts +++ b/packages/core/http/core-http-server-internal/src/lifecycle/on_pre_routing.ts @@ -22,7 +22,7 @@ import { CoreKibanaRequest, isKibanaResponse, lifecycleResponseFactory, -} from '../router'; +} from '@kbn/core-http-router-server-internal'; const preRoutingResult = { next(): OnPreRoutingResult { diff --git a/src/core/server/http/lifecycle_handlers.test.ts b/packages/core/http/core-http-server-internal/src/lifecycle_handlers.test.ts similarity index 90% rename from src/core/server/http/lifecycle_handlers.test.ts rename to packages/core/http/core-http-server-internal/src/lifecycle_handlers.test.ts index 2f2cac972c57a..6fa2ef18353b6 100644 --- a/src/core/server/http/lifecycle_handlers.test.ts +++ b/packages/core/http/core-http-server-internal/src/lifecycle_handlers.test.ts @@ -6,17 +6,34 @@ * Side Public License, v 1. */ -import type { KibanaRequest, RouteMethod, KibanaRouteOptions } from '@kbn/core-http-server'; +import type { + KibanaRequest, + RouteMethod, + KibanaRouteOptions, + OnPreResponseToolkit, + OnPostAuthToolkit, + OnPreRoutingToolkit, +} from '@kbn/core-http-server'; +import { mockRouter } from '@kbn/core-http-router-server-mocks'; import { createCustomHeadersPreResponseHandler, createVersionCheckPostAuthHandler, createXsrfPostAuthHandler, } from './lifecycle_handlers'; -import { httpServerMock } from './http_server.mocks'; import { HttpConfig } from './http_config'; +type ToolkitMock = jest.Mocked; + const createConfig = (partial: Partial): HttpConfig => partial as HttpConfig; +const createToolkit = (): ToolkitMock => { + return { + render: jest.fn(), + next: jest.fn(), + rewriteUrl: jest.fn(), + }; +}; + const forgeRequest = ({ headers = {}, path = '/', @@ -28,7 +45,7 @@ const forgeRequest = ({ method: RouteMethod; kibanaRouteOptions: KibanaRouteOptions; }>): KibanaRequest => { - return httpServerMock.createKibanaRequest({ + return mockRouter.createKibanaRequest({ headers, path, method, @@ -37,12 +54,12 @@ const forgeRequest = ({ }; describe('xsrf post-auth handler', () => { - let toolkit: ReturnType; - let responseFactory: ReturnType; + let toolkit: ToolkitMock; + let responseFactory: ReturnType; beforeEach(() => { - toolkit = httpServerMock.createToolkit(); - responseFactory = httpServerMock.createLifecycleResponseFactory(); + toolkit = createToolkit(); + responseFactory = mockRouter.createResponseFactory(); }); describe('non destructive methods', () => { @@ -165,12 +182,12 @@ describe('xsrf post-auth handler', () => { }); describe('versionCheck post-auth handler', () => { - let toolkit: ReturnType; - let responseFactory: ReturnType; + let toolkit: ToolkitMock; + let responseFactory: ReturnType; beforeEach(() => { - toolkit = httpServerMock.createToolkit(); - responseFactory = httpServerMock.createLifecycleResponseFactory(); + toolkit = createToolkit(); + responseFactory = mockRouter.createResponseFactory(); }); it('forward the request to the next interceptor if header matches', () => { @@ -225,10 +242,10 @@ describe('versionCheck post-auth handler', () => { }); describe('customHeaders pre-response handler', () => { - let toolkit: ReturnType; + let toolkit: ToolkitMock; beforeEach(() => { - toolkit = httpServerMock.createToolkit(); + toolkit = createToolkit(); }); it('adds the kbn-name header to the response', () => { diff --git a/src/core/server/http/lifecycle_handlers.ts b/packages/core/http/core-http-server-internal/src/lifecycle_handlers.ts similarity index 97% rename from src/core/server/http/lifecycle_handlers.ts rename to packages/core/http/core-http-server-internal/src/lifecycle_handlers.ts index b82914b9b985c..11e034a56914b 100644 --- a/src/core/server/http/lifecycle_handlers.ts +++ b/packages/core/http/core-http-server-internal/src/lifecycle_handlers.ts @@ -8,8 +8,8 @@ import { Env } from '@kbn/config'; import type { OnPostAuthHandler, OnPreResponseHandler } from '@kbn/core-http-server'; +import { isSafeMethod } from '@kbn/core-http-router-server-internal'; import { HttpConfig } from './http_config'; -import { isSafeMethod } from './router'; import { LifecycleRegistrar } from './http_server'; const VERSION_HEADER = 'kbn-version'; diff --git a/src/core/server/http/logging/get_payload_size.test.ts b/packages/core/http/core-http-server-internal/src/logging/get_payload_size.test.ts similarity index 100% rename from src/core/server/http/logging/get_payload_size.test.ts rename to packages/core/http/core-http-server-internal/src/logging/get_payload_size.test.ts diff --git a/src/core/server/http/logging/get_payload_size.ts b/packages/core/http/core-http-server-internal/src/logging/get_payload_size.ts similarity index 100% rename from src/core/server/http/logging/get_payload_size.ts rename to packages/core/http/core-http-server-internal/src/logging/get_payload_size.ts diff --git a/src/core/server/http/logging/get_response_log.test.ts b/packages/core/http/core-http-server-internal/src/logging/get_response_log.test.ts similarity index 92% rename from src/core/server/http/logging/get_response_log.test.ts rename to packages/core/http/core-http-server-internal/src/logging/get_response_log.test.ts index 386bf2a263934..a8f607c5c6865 100644 --- a/src/core/server/http/logging/get_response_log.test.ts +++ b/packages/core/http/core-http-server-internal/src/logging/get_response_log.test.ts @@ -189,6 +189,28 @@ describe('getEcsResponseLog', () => { `); }); + test('redacts x-elastic-app-auth headers by default', () => { + const req = createMockHapiRequest({ + headers: { 'x-elastic-app-auth': 'hello', 'user-agent': 'world' }, + response: { headers: { 'content-length': '123', 'x-elastic-app-auth': 'abc' } }, + }); + const result = getEcsResponseLog(req, logger); + // @ts-expect-error ECS custom field + expect(result.meta.http.request.headers).toMatchInlineSnapshot(` + Object { + "user-agent": "world", + "x-elastic-app-auth": "[REDACTED]", + } + `); + // @ts-expect-error ECS custom field + expect(result.meta.http.response.headers).toMatchInlineSnapshot(` + Object { + "content-length": "123", + "x-elastic-app-auth": "[REDACTED]", + } + `); + }); + test('does not mutate original headers', () => { const reqHeaders = { a: 'foo', b: ['hello', 'world'] }; const resHeaders = { headers: { c: 'bar' } }; diff --git a/src/core/server/http/logging/get_response_log.ts b/packages/core/http/core-http-server-internal/src/logging/get_response_log.ts similarity index 95% rename from src/core/server/http/logging/get_response_log.ts rename to packages/core/http/core-http-server-internal/src/logging/get_response_log.ts index 711c4bc1e58c9..f356bf077095a 100644 --- a/src/core/server/http/logging/get_response_log.ts +++ b/packages/core/http/core-http-server-internal/src/logging/get_response_log.ts @@ -14,7 +14,9 @@ import type { LogMeta, Logger } from '@kbn/logging'; import type { KibanaRequestState } from '@kbn/core-http-server'; import { getResponsePayloadBytes } from './get_payload_size'; -const FORBIDDEN_HEADERS = ['authorization', 'cookie', 'set-cookie']; +// If you are updating these, consider whether they should also be updated in the +// elasticsearch service `getEcsResponseLog` +const FORBIDDEN_HEADERS = ['authorization', 'cookie', 'set-cookie', 'x-elastic-app-auth']; const REDACTED_HEADER_TEXT = '[REDACTED]'; type HapiHeaders = Record; diff --git a/src/core/server/http/logging/index.ts b/packages/core/http/core-http-server-internal/src/logging/index.ts similarity index 100% rename from src/core/server/http/logging/index.ts rename to packages/core/http/core-http-server-internal/src/logging/index.ts diff --git a/src/core/server/http/security_response_headers_config.test.ts b/packages/core/http/core-http-server-internal/src/security_response_headers_config.test.ts similarity index 100% rename from src/core/server/http/security_response_headers_config.test.ts rename to packages/core/http/core-http-server-internal/src/security_response_headers_config.test.ts diff --git a/src/core/server/http/security_response_headers_config.ts b/packages/core/http/core-http-server-internal/src/security_response_headers_config.ts similarity index 100% rename from src/core/server/http/security_response_headers_config.ts rename to packages/core/http/core-http-server-internal/src/security_response_headers_config.ts diff --git a/src/core/server/http/types.ts b/packages/core/http/core-http-server-internal/src/types.ts similarity index 100% rename from src/core/server/http/types.ts rename to packages/core/http/core-http-server-internal/src/types.ts diff --git a/packages/core/http/core-http-server-internal/tsconfig.json b/packages/core/http/core-http-server-internal/tsconfig.json new file mode 100644 index 0000000000000..39d3c7097814a --- /dev/null +++ b/packages/core/http/core-http-server-internal/tsconfig.json @@ -0,0 +1,18 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "declarationMap": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/core/http/core-http-server-mocks/BUILD.bazel b/packages/core/http/core-http-server-mocks/BUILD.bazel new file mode 100644 index 0000000000000..f3408be31eb1d --- /dev/null +++ b/packages/core/http/core-http-server-mocks/BUILD.bazel @@ -0,0 +1,119 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "core-http-server-mocks" +PKG_REQUIRE_NAME = "@kbn/core-http-server-mocks" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + ], + exclude = [ + "**/*.test.*", + "**/*.stories.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +RUNTIME_DEPS = [ + "@npm//rxjs", + "@npm//moment", + "//packages/kbn-hapi-mocks", + "//packages/kbn-config-schema", + "//packages/kbn-config-mocks", + "//packages/core/logging/core-logging-server-mocks", + "//packages/core/http/core-http-router-server-mocks", + "//packages/core/http/core-http-router-server-internal", + "//packages/core/http/core-http-server-internal", +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", + "@npm//rxjs", + "@npm//moment", + "@npm//@hapi/hapi", + "@npm//@types/hapi__hapi", + "//packages/kbn-utility-types:npm_module_types", + "//packages/kbn-config-mocks:npm_module_types", + "//packages/kbn-config-schema:npm_module_types", + "//packages/kbn-hapi-mocks:npm_module_types", + "//packages/core/logging/core-logging-server-mocks:npm_module_types", + "//packages/core/http/core-http-server:npm_module_types", + "//packages/core/http/core-http-router-server-mocks:npm_module_types", + "//packages/core/http/core-http-router-server-internal:npm_module_types", + "//packages/core/http/core-http-server-internal:npm_module_types", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + declaration_map = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/core/http/core-http-server-mocks/README.md b/packages/core/http/core-http-server-mocks/README.md new file mode 100644 index 0000000000000..917bc9395db61 --- /dev/null +++ b/packages/core/http/core-http-server-mocks/README.md @@ -0,0 +1,3 @@ +# @kbn/core-http-server-mocks + +This package contains the mocks and test utils for core's server-side `http` service diff --git a/packages/core/http/core-http-server-mocks/jest.config.js b/packages/core/http/core-http-server-mocks/jest.config.js new file mode 100644 index 0000000000000..4f088fda9ea9a --- /dev/null +++ b/packages/core/http/core-http-server-mocks/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test/jest_node', + rootDir: '../../../..', + roots: ['/packages/core/http/core-http-server-mocks'], +}; diff --git a/packages/core/http/core-http-server-mocks/package.json b/packages/core/http/core-http-server-mocks/package.json new file mode 100644 index 0000000000000..d6757d779dfd6 --- /dev/null +++ b/packages/core/http/core-http-server-mocks/package.json @@ -0,0 +1,7 @@ +{ + "name": "@kbn/core-http-server-mocks", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/src/core/server/http/cookie_session_storage.mocks.ts b/packages/core/http/core-http-server-mocks/src/cookie_session_storage.mocks.ts similarity index 100% rename from src/core/server/http/cookie_session_storage.mocks.ts rename to packages/core/http/core-http-server-mocks/src/cookie_session_storage.mocks.ts diff --git a/src/core/server/http/http_server.mocks.ts b/packages/core/http/core-http-server-mocks/src/http_server.mocks.ts similarity index 95% rename from src/core/server/http/http_server.mocks.ts rename to packages/core/http/core-http-server-mocks/src/http_server.mocks.ts index e56535b94482c..8e7d5543e35eb 100644 --- a/src/core/server/http/http_server.mocks.ts +++ b/packages/core/http/core-http-server-mocks/src/http_server.mocks.ts @@ -13,7 +13,7 @@ import type { OnPostAuthToolkit, OnPreRoutingToolkit, } from '@kbn/core-http-server'; -import { mockRouter } from './router/router.mock'; +import { mockRouter } from '@kbn/core-http-router-server-mocks'; const createLifecycleResponseFactoryMock = (): jest.Mocked => ({ redirected: jest.fn(), diff --git a/src/core/server/http/http_service.mock.ts b/packages/core/http/core-http-server-mocks/src/http_service.mock.ts similarity index 97% rename from src/core/server/http/http_service.mock.ts rename to packages/core/http/core-http-server-mocks/src/http_service.mock.ts index 5ef94cff3110a..ec90929a0dc6f 100644 --- a/src/core/server/http/http_service.mock.ts +++ b/packages/core/http/core-http-server-mocks/src/http_service.mock.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { Server } from '@hapi/hapi'; +import type { Server } from '@hapi/hapi'; import type { PublicMethodsOf } from '@kbn/utility-types'; import { configMock } from '@kbn/config-mocks'; import type { @@ -22,17 +22,16 @@ import type { HttpServiceStart, } from '@kbn/core-http-server'; import { AuthStatus } from '@kbn/core-http-server'; +import { mockRouter, RouterMock } from '@kbn/core-http-router-server-mocks'; -import { CspConfig } from './csp'; -import { mockRouter, RouterMock } from './router/router.mock'; -import { +import { CspConfig, ExternalUrlConfig } from '@kbn/core-http-server-internal'; +import type { + HttpService, InternalHttpServicePreboot, InternalHttpServiceSetup, InternalHttpServiceStart, -} from './types'; -import { HttpService } from './http_service'; +} from '@kbn/core-http-server-internal'; import { sessionStorageMock } from './cookie_session_storage.mocks'; -import { ExternalUrlConfig } from './external_url'; type BasePathMocked = jest.Mocked; type AuthMocked = jest.Mocked; diff --git a/packages/core/http/core-http-server-mocks/src/index.ts b/packages/core/http/core-http-server-mocks/src/index.ts new file mode 100644 index 0000000000000..ca4e44d1c3e8d --- /dev/null +++ b/packages/core/http/core-http-server-mocks/src/index.ts @@ -0,0 +1,20 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export { sessionStorageMock } from './cookie_session_storage.mocks'; +export { httpServerMock } from './http_server.mocks'; +export { httpServiceMock } from './http_service.mock'; +export type { + HttpServicePrebootMock, + HttpServiceSetupMock, + HttpServiceStartMock, + InternalHttpServicePrebootMock, + InternalHttpServiceSetupMock, + InternalHttpServiceStartMock, +} from './http_service.mock'; +export { createCoreContext, createHttpServer } from './test_utils'; diff --git a/packages/core/http/core-http-server-mocks/src/test_utils.ts b/packages/core/http/core-http-server-mocks/src/test_utils.ts new file mode 100644 index 0000000000000..2b9658693dce7 --- /dev/null +++ b/packages/core/http/core-http-server-mocks/src/test_utils.ts @@ -0,0 +1,90 @@ +/* + * 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 { BehaviorSubject } from 'rxjs'; +import moment from 'moment'; +import { REPO_ROOT } from '@kbn/utils'; +import { ByteSizeValue } from '@kbn/config-schema'; +import { Env } from '@kbn/config'; +import { getEnvOptions, configServiceMock } from '@kbn/config-mocks'; +import type { CoreContext } from '@kbn/core-base-server-internal'; +import { loggingSystemMock } from '@kbn/core-logging-server-mocks'; +import { HttpService } from '@kbn/core-http-server-internal'; + +const coreId = Symbol('core'); +const env = Env.createDefault(REPO_ROOT, getEnvOptions()); + +const logger = loggingSystemMock.create(); + +const createConfigService = () => { + const configService = configServiceMock.create(); + configService.atPath.mockImplementation((path) => { + if (path === 'server') { + return new BehaviorSubject({ + hosts: ['localhost'], + maxPayload: new ByteSizeValue(1024), + autoListen: true, + ssl: { + enabled: false, + }, + cors: { + enabled: false, + }, + compression: { enabled: true }, + xsrf: { + disableProtection: true, + allowlist: [], + }, + securityResponseHeaders: {}, + customResponseHeaders: {}, + requestId: { + allowFromAnyIp: true, + ipAllowlist: [], + }, + shutdownTimeout: moment.duration(30, 'seconds'), + keepaliveTimeout: 120_000, + socketTimeout: 120_000, + } as any); + } + if (path === 'externalUrl') { + return new BehaviorSubject({ + policy: [], + } as any); + } + if (path === 'csp') { + return new BehaviorSubject({ + strict: false, + disableEmbedding: false, + warnLegacyBrowsers: true, + }); + } + throw new Error(`Unexpected config path: ${path}`); + }); + return configService; +}; + +const createDefaultContext = (): CoreContext => { + return { + coreId, + env, + logger, + configService: createConfigService(), + }; +}; + +export const createCoreContext = (overrides: Partial = {}): CoreContext => ({ + ...createDefaultContext(), + ...overrides, +}); + +/** + * Creates a concrete HttpServer with a mocked context. + */ +export const createHttpServer = (overrides: Partial = {}): HttpService => { + return new HttpService(createCoreContext(overrides)); +}; diff --git a/packages/core/http/core-http-server-mocks/tsconfig.json b/packages/core/http/core-http-server-mocks/tsconfig.json new file mode 100644 index 0000000000000..39d3c7097814a --- /dev/null +++ b/packages/core/http/core-http-server-mocks/tsconfig.json @@ -0,0 +1,18 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "declarationMap": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/core/http/core-http-server/BUILD.bazel b/packages/core/http/core-http-server/BUILD.bazel index 927caf4686607..007004a548ee8 100644 --- a/packages/core/http/core-http-server/BUILD.bazel +++ b/packages/core/http/core-http-server/BUILD.bazel @@ -39,7 +39,8 @@ TYPES_DEPS = [ "@npm//@hapi/boom", "//packages/kbn-config-schema:npm_module_types", "//packages/kbn-utility-types:npm_module_types", - "//packages/core/base/core-base-common:npm_module_types" + "//packages/core/base/core-base-common:npm_module_types", + "//packages/core/http/core-http-common:npm_module_types" ] jsts_transpiler( diff --git a/packages/core/http/core-http-server/src/external_url.ts b/packages/core/http/core-http-server/src/external_url.ts index 05aa5c1b0e960..ef24015a3fded 100644 --- a/packages/core/http/core-http-server/src/external_url.ts +++ b/packages/core/http/core-http-server/src/external_url.ts @@ -6,6 +6,8 @@ * Side Public License, v 1. */ +import type { IExternalUrlPolicy } from '@kbn/core-http-common'; + /** * External Url configuration for use in Kibana. * @public @@ -16,40 +18,3 @@ export interface IExternalUrlConfig { */ readonly policy: IExternalUrlPolicy[]; } - -/** - * A policy describing whether access to an external destination is allowed. - * @public - */ -export interface IExternalUrlPolicy { - /** - * Indicates if this policy allows or denies access to the described destination. - */ - allow: boolean; - - /** - * Optional host describing the external destination. - * May be combined with `protocol`. - * - * @example - * ```ts - * // allows access to all of google.com, using any protocol. - * allow: true, - * host: 'google.com' - * ``` - */ - host?: string; - - /** - * Optional protocol describing the external destination. - * May be combined with `host`. - * - * @example - * ```ts - * // allows access to all destinations over the `https` protocol. - * allow: true, - * protocol: 'https' - * ``` - */ - protocol?: string; -} diff --git a/packages/core/http/core-http-server/src/index.ts b/packages/core/http/core-http-server/src/index.ts index efd247adc9e5e..1a553952c6b7e 100644 --- a/packages/core/http/core-http-server/src/index.ts +++ b/packages/core/http/core-http-server/src/index.ts @@ -102,7 +102,7 @@ export { validBodyOutput, RouteValidationError } from './router'; export type { ICspConfig } from './csp'; -export type { IExternalUrlPolicy, IExternalUrlConfig } from './external_url'; +export type { IExternalUrlConfig } from './external_url'; export type { IBasePath } from './base_path'; diff --git a/packages/kbn-crypto-browser/BUILD.bazel b/packages/kbn-crypto-browser/BUILD.bazel new file mode 100644 index 0000000000000..c9d0c6e9eefc5 --- /dev/null +++ b/packages/kbn-crypto-browser/BUILD.bazel @@ -0,0 +1,104 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "kbn-crypto-browser" +PKG_REQUIRE_NAME = "@kbn/crypto-browser" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + "src/**/*.tsx", + ], + exclude = [ + "**/*.test.*", + "**/*.story.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +RUNTIME_DEPS = [ +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +jsts_transpiler( + name = "target_web", + srcs = SRCS, + build_pkg_name = package_name(), + web = True, +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node", ":target_web"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/kbn-crypto-browser/README.md b/packages/kbn-crypto-browser/README.md new file mode 100644 index 0000000000000..6ddc9ea7eafe5 --- /dev/null +++ b/packages/kbn-crypto-browser/README.md @@ -0,0 +1,3 @@ +# @kbn/crypto-browser + +Crypto tools and utilities for Kibana, browser-side diff --git a/packages/kbn-crypto-browser/jest.config.js b/packages/kbn-crypto-browser/jest.config.js new file mode 100644 index 0000000000000..6e589e691288c --- /dev/null +++ b/packages/kbn-crypto-browser/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test', + rootDir: '../..', + roots: ['/packages/kbn-crypto-browser'], +}; diff --git a/packages/kbn-crypto-browser/package.json b/packages/kbn-crypto-browser/package.json new file mode 100644 index 0000000000000..42bf708c93cdf --- /dev/null +++ b/packages/kbn-crypto-browser/package.json @@ -0,0 +1,8 @@ +{ + "name": "@kbn/crypto-browser", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "browser": "./target_web/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/src/core/public/utils/crypto/index.ts b/packages/kbn-crypto-browser/src/index.ts similarity index 100% rename from src/core/public/utils/crypto/index.ts rename to packages/kbn-crypto-browser/src/index.ts diff --git a/src/core/public/utils/crypto/sha256.ts b/packages/kbn-crypto-browser/src/sha256.ts similarity index 100% rename from src/core/public/utils/crypto/sha256.ts rename to packages/kbn-crypto-browser/src/sha256.ts diff --git a/packages/kbn-crypto-browser/tsconfig.json b/packages/kbn-crypto-browser/tsconfig.json new file mode 100644 index 0000000000000..a8cfc2cceb08b --- /dev/null +++ b/packages/kbn-crypto-browser/tsconfig.json @@ -0,0 +1,17 @@ +{ + "extends": "../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/kbn-crypto/BUILD.bazel b/packages/kbn-crypto/BUILD.bazel index 09c5fbb47e3aa..0a7dfb8dc2d7f 100644 --- a/packages/kbn-crypto/BUILD.bazel +++ b/packages/kbn-crypto/BUILD.bazel @@ -28,7 +28,7 @@ NPM_MODULE_EXTRA_FILES = [ ] RUNTIME_DEPS = [ - "//packages/kbn-dev-utils:build", + "//packages/kbn-dev-utils", "@npm//node-forge", ] diff --git a/packages/kbn-crypto/README.md b/packages/kbn-crypto/README.md index 4404c22eba37c..ec0a4b8e13c1d 100644 --- a/packages/kbn-crypto/README.md +++ b/packages/kbn-crypto/README.md @@ -1,3 +1,3 @@ # @kbn/crypto -Crypto tools and utilities for Kibana \ No newline at end of file +Crypto tools and utilities for Kibana, server-side diff --git a/packages/kbn-doc-links/src/get_doc_links.ts b/packages/kbn-doc-links/src/get_doc_links.ts index 87bc77e61bae5..ee2fb5143e92b 100644 --- a/packages/kbn-doc-links/src/get_doc_links.ts +++ b/packages/kbn-doc-links/src/get_doc_links.ts @@ -341,6 +341,7 @@ export const getDocLinks = ({ kibanaBranch }: GetDocLinkOptions): DocLinks => { blocklist: `${ELASTIC_WEBSITE_URL}guide/en/security/${DOC_LINK_VERSION}/blocklist.html`, policyResponseTroubleshooting: { full_disk_access: `${ELASTIC_WEBSITE_URL}guide/en/security/${DOC_LINK_VERSION}/deploy-elastic-endpoint.html#enable-fda-endpoint`, + macos_system_ext: `${ELASTIC_WEBSITE_URL}guide/en/security/${DOC_LINK_VERSION}/deploy-elastic-endpoint.html#system-extension-endpoint`, }, }, query: { diff --git a/packages/kbn-doc-links/src/types.ts b/packages/kbn-doc-links/src/types.ts index 3a0e57b43c169..8a7a0e788cbc3 100644 --- a/packages/kbn-doc-links/src/types.ts +++ b/packages/kbn-doc-links/src/types.ts @@ -247,6 +247,7 @@ export interface DocLinks { readonly blocklist: string; readonly policyResponseTroubleshooting: { full_disk_access: string; + macos_system_ext: string; }; }; readonly query: { diff --git a/packages/kbn-es-archiver/BUILD.bazel b/packages/kbn-es-archiver/BUILD.bazel index a95c5f82cd289..bb57660af69ac 100644 --- a/packages/kbn-es-archiver/BUILD.bazel +++ b/packages/kbn-es-archiver/BUILD.bazel @@ -39,7 +39,6 @@ RUNTIME_DEPS = [ "@npm//json-stable-stringify", "@npm//lodash", "@npm//sinon", - "@npm//zlib", ] TYPES_DEPS = [ @@ -50,7 +49,6 @@ TYPES_DEPS = [ "@npm//@elastic/elasticsearch", "@npm//aggregate-error", "@npm//globby", - "@npm//zlib", "@npm//@types/chance", "@npm//@types/jest", "@npm//@types/json-stable-stringify", diff --git a/packages/kbn-es/BUILD.bazel b/packages/kbn-es/BUILD.bazel index 892cd43244de7..4f6d61b42dbc7 100644 --- a/packages/kbn-es/BUILD.bazel +++ b/packages/kbn-es/BUILD.bazel @@ -38,7 +38,6 @@ RUNTIME_DEPS = [ "@npm//node-fetch", "@npm//simple-git", "@npm//tree-kill", - "@npm//zlib" ] jsts_transpiler( diff --git a/packages/kbn-optimizer/BUILD.bazel b/packages/kbn-optimizer/BUILD.bazel index a514c43b9ce5a..cc967e77adde9 100644 --- a/packages/kbn-optimizer/BUILD.bazel +++ b/packages/kbn-optimizer/BUILD.bazel @@ -59,7 +59,6 @@ RUNTIME_DEPS = [ "@npm//webpack", "@npm//webpack-merge", "@npm//webpack-sources", - "@npm//zlib" ] TYPES_DEPS = [ @@ -81,7 +80,6 @@ TYPES_DEPS = [ "@npm//lmdb-store", "@npm//pirates", "@npm//rxjs", - "@npm//zlib", "@npm//@types/babel__core", "@npm//@types/compression-webpack-plugin", "@npm//@types/dedent", diff --git a/packages/kbn-pm/dist/index.js b/packages/kbn-pm/dist/index.js index 3b48937eb1098..647e8a8d4bbbe 100644 --- a/packages/kbn-pm/dist/index.js +++ b/packages/kbn-pm/dist/index.js @@ -23894,7209 +23894,6648 @@ module.exports = AggregateError; /***/ }), -/***/ "../../node_modules/del/node_modules/fast-glob/out/index.js": +/***/ "../../node_modules/del/node_modules/globby/gitignore.js": /***/ (function(module, exports, __webpack_require__) { "use strict"; -const taskManager = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/managers/tasks.js"); -const async_1 = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/providers/async.js"); -const stream_1 = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/providers/stream.js"); -const sync_1 = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/providers/sync.js"); -const settings_1 = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/settings.js"); -const utils = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/utils/index.js"); -async function FastGlob(source, options) { - assertPatternsInput(source); - const works = getWorks(source, async_1.default, options); - const result = await Promise.all(works); - return utils.array.flatten(result); -} -// https://github.com/typescript-eslint/typescript-eslint/issues/60 -// eslint-disable-next-line no-redeclare -(function (FastGlob) { - function sync(source, options) { - assertPatternsInput(source); - const works = getWorks(source, sync_1.default, options); - return utils.array.flatten(works); - } - FastGlob.sync = sync; - function stream(source, options) { - assertPatternsInput(source); - const works = getWorks(source, stream_1.default, options); - /** - * The stream returned by the provider cannot work with an asynchronous iterator. - * To support asynchronous iterators, regardless of the number of tasks, we always multiplex streams. - * This affects performance (+25%). I don't see best solution right now. - */ - return utils.stream.merge(works); - } - FastGlob.stream = stream; - function generateTasks(source, options) { - assertPatternsInput(source); - const patterns = [].concat(source); - const settings = new settings_1.default(options); - return taskManager.generate(patterns, settings); - } - FastGlob.generateTasks = generateTasks; - function isDynamicPattern(source, options) { - assertPatternsInput(source); - const settings = new settings_1.default(options); - return utils.pattern.isDynamicPattern(source, settings); - } - FastGlob.isDynamicPattern = isDynamicPattern; - function escapePath(source) { - assertPatternsInput(source); - return utils.path.escape(source); - } - FastGlob.escapePath = escapePath; -})(FastGlob || (FastGlob = {})); -function getWorks(source, _Provider, options) { - const patterns = [].concat(source); - const settings = new settings_1.default(options); - const tasks = taskManager.generate(patterns, settings); - const provider = new _Provider(settings); - return tasks.map(provider.read, provider); -} -function assertPatternsInput(input) { - const source = [].concat(input); - const isValidSource = source.every((item) => utils.string.isString(item) && !utils.string.isEmpty(item)); - if (!isValidSource) { - throw new TypeError('Patterns must be a string (non empty) or an array of strings'); - } -} -module.exports = FastGlob; +const {promisify} = __webpack_require__("util"); +const fs = __webpack_require__("fs"); +const path = __webpack_require__("path"); +const fastGlob = __webpack_require__("../../node_modules/fast-glob/out/index.js"); +const gitIgnore = __webpack_require__("../../node_modules/ignore/index.js"); +const slash = __webpack_require__("../../node_modules/slash/index.js"); +const DEFAULT_IGNORE = [ + '**/node_modules/**', + '**/flow-typed/**', + '**/coverage/**', + '**/.git' +]; -/***/ }), +const readFileP = promisify(fs.readFile); -/***/ "../../node_modules/del/node_modules/fast-glob/out/managers/tasks.js": -/***/ (function(module, exports, __webpack_require__) { +const mapGitIgnorePatternTo = base => ignore => { + if (ignore.startsWith('!')) { + return '!' + path.posix.join(base, ignore.slice(1)); + } -"use strict"; + return path.posix.join(base, ignore); +}; -Object.defineProperty(exports, "__esModule", { value: true }); -exports.convertPatternGroupToTask = exports.convertPatternGroupsToTasks = exports.groupPatternsByBaseDirectory = exports.getNegativePatternsAsPositive = exports.getPositivePatterns = exports.convertPatternsToTasks = exports.generate = void 0; -const utils = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/utils/index.js"); -function generate(patterns, settings) { - const positivePatterns = getPositivePatterns(patterns); - const negativePatterns = getNegativePatternsAsPositive(patterns, settings.ignore); - const staticPatterns = positivePatterns.filter((pattern) => utils.pattern.isStaticPattern(pattern, settings)); - const dynamicPatterns = positivePatterns.filter((pattern) => utils.pattern.isDynamicPattern(pattern, settings)); - const staticTasks = convertPatternsToTasks(staticPatterns, negativePatterns, /* dynamic */ false); - const dynamicTasks = convertPatternsToTasks(dynamicPatterns, negativePatterns, /* dynamic */ true); - return staticTasks.concat(dynamicTasks); -} -exports.generate = generate; -/** - * Returns tasks grouped by basic pattern directories. - * - * Patterns that can be found inside (`./`) and outside (`../`) the current directory are handled separately. - * This is necessary because directory traversal starts at the base directory and goes deeper. - */ -function convertPatternsToTasks(positive, negative, dynamic) { - const tasks = []; - const patternsOutsideCurrentDirectory = utils.pattern.getPatternsOutsideCurrentDirectory(positive); - const patternsInsideCurrentDirectory = utils.pattern.getPatternsInsideCurrentDirectory(positive); - const outsideCurrentDirectoryGroup = groupPatternsByBaseDirectory(patternsOutsideCurrentDirectory); - const insideCurrentDirectoryGroup = groupPatternsByBaseDirectory(patternsInsideCurrentDirectory); - tasks.push(...convertPatternGroupsToTasks(outsideCurrentDirectoryGroup, negative, dynamic)); - /* - * For the sake of reducing future accesses to the file system, we merge all tasks within the current directory - * into a global task, if at least one pattern refers to the root (`.`). In this case, the global task covers the rest. - */ - if ('.' in insideCurrentDirectoryGroup) { - tasks.push(convertPatternGroupToTask('.', patternsInsideCurrentDirectory, negative, dynamic)); - } - else { - tasks.push(...convertPatternGroupsToTasks(insideCurrentDirectoryGroup, negative, dynamic)); - } - return tasks; -} -exports.convertPatternsToTasks = convertPatternsToTasks; -function getPositivePatterns(patterns) { - return utils.pattern.getPositivePatterns(patterns); -} -exports.getPositivePatterns = getPositivePatterns; -function getNegativePatternsAsPositive(patterns, ignore) { - const negative = utils.pattern.getNegativePatterns(patterns).concat(ignore); - const positive = negative.map(utils.pattern.convertToPositivePattern); - return positive; -} -exports.getNegativePatternsAsPositive = getNegativePatternsAsPositive; -function groupPatternsByBaseDirectory(patterns) { - const group = {}; - return patterns.reduce((collection, pattern) => { - const base = utils.pattern.getBaseDirectory(pattern); - if (base in collection) { - collection[base].push(pattern); - } - else { - collection[base] = [pattern]; - } - return collection; - }, group); -} -exports.groupPatternsByBaseDirectory = groupPatternsByBaseDirectory; -function convertPatternGroupsToTasks(positive, negative, dynamic) { - return Object.keys(positive).map((base) => { - return convertPatternGroupToTask(base, positive[base], negative, dynamic); - }); -} -exports.convertPatternGroupsToTasks = convertPatternGroupsToTasks; -function convertPatternGroupToTask(base, positive, negative, dynamic) { - return { - dynamic, - positive, - negative, - base, - patterns: [].concat(positive, negative.map(utils.pattern.convertToNegativePattern)) - }; -} -exports.convertPatternGroupToTask = convertPatternGroupToTask; +const parseGitIgnore = (content, options) => { + const base = slash(path.relative(options.cwd, path.dirname(options.fileName))); + return content + .split(/\r?\n/) + .filter(Boolean) + .filter(line => !line.startsWith('#')) + .map(mapGitIgnorePatternTo(base)); +}; -/***/ }), +const reduceIgnore = files => { + return files.reduce((ignores, file) => { + ignores.add(parseGitIgnore(file.content, { + cwd: file.cwd, + fileName: file.filePath + })); + return ignores; + }, gitIgnore()); +}; -/***/ "../../node_modules/del/node_modules/fast-glob/out/providers/async.js": -/***/ (function(module, exports, __webpack_require__) { +const ensureAbsolutePathForCwd = (cwd, p) => { + if (path.isAbsolute(p)) { + if (p.startsWith(cwd)) { + return p; + } -"use strict"; + throw new Error(`Path ${p} is not in cwd ${cwd}`); + } -Object.defineProperty(exports, "__esModule", { value: true }); -const stream_1 = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/readers/stream.js"); -const provider_1 = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/providers/provider.js"); -class ProviderAsync extends provider_1.default { - constructor() { - super(...arguments); - this._reader = new stream_1.default(this._settings); - } - read(task) { - const root = this._getRootDirectory(task); - const options = this._getReaderOptions(task); - const entries = []; - return new Promise((resolve, reject) => { - const stream = this.api(root, task, options); - stream.once('error', reject); - stream.on('data', (entry) => entries.push(options.transform(entry))); - stream.once('end', () => resolve(entries)); - }); - } - api(root, task, options) { - if (task.dynamic) { - return this._reader.dynamic(root, options); - } - return this._reader.static(task.patterns, options); - } -} -exports.default = ProviderAsync; + return path.join(cwd, p); +}; +const getIsIgnoredPredecate = (ignores, cwd) => { + return p => ignores.ignores(slash(path.relative(cwd, ensureAbsolutePathForCwd(cwd, p)))); +}; -/***/ }), +const getFile = async (file, cwd) => { + const filePath = path.join(cwd, file); + const content = await readFileP(filePath, 'utf8'); -/***/ "../../node_modules/del/node_modules/fast-glob/out/providers/filters/deep.js": -/***/ (function(module, exports, __webpack_require__) { + return { + cwd, + filePath, + content + }; +}; -"use strict"; - -Object.defineProperty(exports, "__esModule", { value: true }); -const utils = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/utils/index.js"); -const partial_1 = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/providers/matchers/partial.js"); -class DeepFilter { - constructor(_settings, _micromatchOptions) { - this._settings = _settings; - this._micromatchOptions = _micromatchOptions; - } - getFilter(basePath, positive, negative) { - const matcher = this._getMatcher(positive); - const negativeRe = this._getNegativePatternsRe(negative); - return (entry) => this._filter(basePath, entry, matcher, negativeRe); - } - _getMatcher(patterns) { - return new partial_1.default(patterns, this._settings, this._micromatchOptions); - } - _getNegativePatternsRe(patterns) { - const affectDepthOfReadingPatterns = patterns.filter(utils.pattern.isAffectDepthOfReadingPattern); - return utils.pattern.convertPatternsToRe(affectDepthOfReadingPatterns, this._micromatchOptions); - } - _filter(basePath, entry, matcher, negativeRe) { - if (this._isSkippedByDeep(basePath, entry.path)) { - return false; - } - if (this._isSkippedSymbolicLink(entry)) { - return false; - } - const filepath = utils.path.removeLeadingDotSegment(entry.path); - if (this._isSkippedByPositivePatterns(filepath, matcher)) { - return false; - } - return this._isSkippedByNegativePatterns(filepath, negativeRe); - } - _isSkippedByDeep(basePath, entryPath) { - /** - * Avoid unnecessary depth calculations when it doesn't matter. - */ - if (this._settings.deep === Infinity) { - return false; - } - return this._getEntryLevel(basePath, entryPath) >= this._settings.deep; - } - _getEntryLevel(basePath, entryPath) { - const entryPathDepth = entryPath.split('/').length; - if (basePath === '') { - return entryPathDepth; - } - const basePathDepth = basePath.split('/').length; - return entryPathDepth - basePathDepth; - } - _isSkippedSymbolicLink(entry) { - return !this._settings.followSymbolicLinks && entry.dirent.isSymbolicLink(); - } - _isSkippedByPositivePatterns(entryPath, matcher) { - return !this._settings.baseNameMatch && !matcher.match(entryPath); - } - _isSkippedByNegativePatterns(entryPath, patternsRe) { - return !utils.pattern.matchAny(entryPath, patternsRe); - } -} -exports.default = DeepFilter; +const getFileSync = (file, cwd) => { + const filePath = path.join(cwd, file); + const content = fs.readFileSync(filePath, 'utf8'); + return { + cwd, + filePath, + content + }; +}; -/***/ }), +const normalizeOptions = ({ + ignore = [], + cwd = slash(process.cwd()) +} = {}) => { + return {ignore, cwd}; +}; -/***/ "../../node_modules/del/node_modules/fast-glob/out/providers/filters/entry.js": -/***/ (function(module, exports, __webpack_require__) { +module.exports = async options => { + options = normalizeOptions(options); -"use strict"; + const paths = await fastGlob('**/.gitignore', { + ignore: DEFAULT_IGNORE.concat(options.ignore), + cwd: options.cwd + }); -Object.defineProperty(exports, "__esModule", { value: true }); -const utils = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/utils/index.js"); -class EntryFilter { - constructor(_settings, _micromatchOptions) { - this._settings = _settings; - this._micromatchOptions = _micromatchOptions; - this.index = new Map(); - } - getFilter(positive, negative) { - const positiveRe = utils.pattern.convertPatternsToRe(positive, this._micromatchOptions); - const negativeRe = utils.pattern.convertPatternsToRe(negative, this._micromatchOptions); - return (entry) => this._filter(entry, positiveRe, negativeRe); - } - _filter(entry, positiveRe, negativeRe) { - if (this._settings.unique && this._isDuplicateEntry(entry)) { - return false; - } - if (this._onlyFileFilter(entry) || this._onlyDirectoryFilter(entry)) { - return false; - } - if (this._isSkippedByAbsoluteNegativePatterns(entry.path, negativeRe)) { - return false; - } - const filepath = this._settings.baseNameMatch ? entry.name : entry.path; - const isMatched = this._isMatchToPatterns(filepath, positiveRe) && !this._isMatchToPatterns(entry.path, negativeRe); - if (this._settings.unique && isMatched) { - this._createIndexRecord(entry); - } - return isMatched; - } - _isDuplicateEntry(entry) { - return this.index.has(entry.path); - } - _createIndexRecord(entry) { - this.index.set(entry.path, undefined); - } - _onlyFileFilter(entry) { - return this._settings.onlyFiles && !entry.dirent.isFile(); - } - _onlyDirectoryFilter(entry) { - return this._settings.onlyDirectories && !entry.dirent.isDirectory(); - } - _isSkippedByAbsoluteNegativePatterns(entryPath, patternsRe) { - if (!this._settings.absolute) { - return false; - } - const fullpath = utils.path.makeAbsolute(this._settings.cwd, entryPath); - return utils.pattern.matchAny(fullpath, patternsRe); - } - _isMatchToPatterns(entryPath, patternsRe) { - const filepath = utils.path.removeLeadingDotSegment(entryPath); - return utils.pattern.matchAny(filepath, patternsRe); - } -} -exports.default = EntryFilter; + const files = await Promise.all(paths.map(file => getFile(file, options.cwd))); + const ignores = reduceIgnore(files); + return getIsIgnoredPredecate(ignores, options.cwd); +}; -/***/ }), +module.exports.sync = options => { + options = normalizeOptions(options); -/***/ "../../node_modules/del/node_modules/fast-glob/out/providers/filters/error.js": -/***/ (function(module, exports, __webpack_require__) { + const paths = fastGlob.sync('**/.gitignore', { + ignore: DEFAULT_IGNORE.concat(options.ignore), + cwd: options.cwd + }); -"use strict"; + const files = paths.map(file => getFileSync(file, options.cwd)); + const ignores = reduceIgnore(files); -Object.defineProperty(exports, "__esModule", { value: true }); -const utils = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/utils/index.js"); -class ErrorFilter { - constructor(_settings) { - this._settings = _settings; - } - getFilter() { - return (error) => this._isNonFatalError(error); - } - _isNonFatalError(error) { - return utils.errno.isEnoentCodeError(error) || this._settings.suppressErrors; - } -} -exports.default = ErrorFilter; + return getIsIgnoredPredecate(ignores, options.cwd); +}; /***/ }), -/***/ "../../node_modules/del/node_modules/fast-glob/out/providers/matchers/matcher.js": +/***/ "../../node_modules/del/node_modules/globby/index.js": /***/ (function(module, exports, __webpack_require__) { "use strict"; -Object.defineProperty(exports, "__esModule", { value: true }); -const utils = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/utils/index.js"); -class Matcher { - constructor(_patterns, _settings, _micromatchOptions) { - this._patterns = _patterns; - this._settings = _settings; - this._micromatchOptions = _micromatchOptions; - this._storage = []; - this._fillStorage(); - } - _fillStorage() { - /** - * The original pattern may include `{,*,**,a/*}`, which will lead to problems with matching (unresolved level). - * So, before expand patterns with brace expansion into separated patterns. - */ - const patterns = utils.pattern.expandPatternsWithBraceExpansion(this._patterns); - for (const pattern of patterns) { - const segments = this._getPatternSegments(pattern); - const sections = this._splitSegmentsIntoSections(segments); - this._storage.push({ - complete: sections.length <= 1, - pattern, - segments, - sections - }); - } - } - _getPatternSegments(pattern) { - const parts = utils.pattern.getPatternParts(pattern, this._micromatchOptions); - return parts.map((part) => { - const dynamic = utils.pattern.isDynamicPattern(part, this._settings); - if (!dynamic) { - return { - dynamic: false, - pattern: part - }; - } - return { - dynamic: true, - pattern: part, - patternRe: utils.pattern.makeRe(part, this._micromatchOptions) - }; - }); - } - _splitSegmentsIntoSections(segments) { - return utils.array.splitWhen(segments, (segment) => segment.dynamic && utils.pattern.hasGlobStar(segment.pattern)); - } -} -exports.default = Matcher; - - -/***/ }), +const fs = __webpack_require__("fs"); +const arrayUnion = __webpack_require__("../../node_modules/array-union/index.js"); +const merge2 = __webpack_require__("../../node_modules/merge2/index.js"); +const glob = __webpack_require__("../../node_modules/glob/glob.js"); +const fastGlob = __webpack_require__("../../node_modules/fast-glob/out/index.js"); +const dirGlob = __webpack_require__("../../node_modules/dir-glob/index.js"); +const gitignore = __webpack_require__("../../node_modules/del/node_modules/globby/gitignore.js"); +const {FilterStream, UniqueStream} = __webpack_require__("../../node_modules/del/node_modules/globby/stream-utils.js"); -/***/ "../../node_modules/del/node_modules/fast-glob/out/providers/matchers/partial.js": -/***/ (function(module, exports, __webpack_require__) { +const DEFAULT_FILTER = () => false; -"use strict"; +const isNegative = pattern => pattern[0] === '!'; -Object.defineProperty(exports, "__esModule", { value: true }); -const matcher_1 = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/providers/matchers/matcher.js"); -class PartialMatcher extends matcher_1.default { - match(filepath) { - const parts = filepath.split('/'); - const levels = parts.length; - const patterns = this._storage.filter((info) => !info.complete || info.segments.length > levels); - for (const pattern of patterns) { - const section = pattern.sections[0]; - /** - * In this case, the pattern has a globstar and we must read all directories unconditionally, - * but only if the level has reached the end of the first group. - * - * fixtures/{a,b}/** - * ^ true/false ^ always true - */ - if (!pattern.complete && levels > section.length) { - return true; - } - const match = parts.every((part, index) => { - const segment = pattern.segments[index]; - if (segment.dynamic && segment.patternRe.test(part)) { - return true; - } - if (!segment.dynamic && segment.pattern === part) { - return true; - } - return false; - }); - if (match) { - return true; - } - } - return false; - } -} -exports.default = PartialMatcher; +const assertPatternsInput = patterns => { + if (!patterns.every(pattern => typeof pattern === 'string')) { + throw new TypeError('Patterns must be a string or an array of strings'); + } +}; +const checkCwdOption = (options = {}) => { + if (!options.cwd) { + return; + } -/***/ }), + let stat; + try { + stat = fs.statSync(options.cwd); + } catch (_) { + return; + } -/***/ "../../node_modules/del/node_modules/fast-glob/out/providers/provider.js": -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; + if (!stat.isDirectory()) { + throw new Error('The `cwd` option must be a path to a directory'); + } +}; -Object.defineProperty(exports, "__esModule", { value: true }); -const path = __webpack_require__("path"); -const deep_1 = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/providers/filters/deep.js"); -const entry_1 = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/providers/filters/entry.js"); -const error_1 = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/providers/filters/error.js"); -const entry_2 = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/providers/transformers/entry.js"); -class Provider { - constructor(_settings) { - this._settings = _settings; - this.errorFilter = new error_1.default(this._settings); - this.entryFilter = new entry_1.default(this._settings, this._getMicromatchOptions()); - this.deepFilter = new deep_1.default(this._settings, this._getMicromatchOptions()); - this.entryTransformer = new entry_2.default(this._settings); - } - _getRootDirectory(task) { - return path.resolve(this._settings.cwd, task.base); - } - _getReaderOptions(task) { - const basePath = task.base === '.' ? '' : task.base; - return { - basePath, - pathSegmentSeparator: '/', - concurrency: this._settings.concurrency, - deepFilter: this.deepFilter.getFilter(basePath, task.positive, task.negative), - entryFilter: this.entryFilter.getFilter(task.positive, task.negative), - errorFilter: this.errorFilter.getFilter(), - followSymbolicLinks: this._settings.followSymbolicLinks, - fs: this._settings.fs, - stats: this._settings.stats, - throwErrorOnBrokenSymbolicLink: this._settings.throwErrorOnBrokenSymbolicLink, - transform: this.entryTransformer.getTransformer() - }; - } - _getMicromatchOptions() { - return { - dot: this._settings.dot, - matchBase: this._settings.baseNameMatch, - nobrace: !this._settings.braceExpansion, - nocase: !this._settings.caseSensitiveMatch, - noext: !this._settings.extglob, - noglobstar: !this._settings.globstar, - posix: true, - strictSlashes: false - }; - } -} -exports.default = Provider; +const getPathString = p => p.stats instanceof fs.Stats ? p.path : p; +const generateGlobTasks = (patterns, taskOptions) => { + patterns = arrayUnion([].concat(patterns)); + assertPatternsInput(patterns); + checkCwdOption(taskOptions); -/***/ }), + const globTasks = []; -/***/ "../../node_modules/del/node_modules/fast-glob/out/providers/stream.js": -/***/ (function(module, exports, __webpack_require__) { + taskOptions = { + ignore: [], + expandDirectories: true, + ...taskOptions + }; -"use strict"; + for (const [index, pattern] of patterns.entries()) { + if (isNegative(pattern)) { + continue; + } -Object.defineProperty(exports, "__esModule", { value: true }); -const stream_1 = __webpack_require__("stream"); -const stream_2 = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/readers/stream.js"); -const provider_1 = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/providers/provider.js"); -class ProviderStream extends provider_1.default { - constructor() { - super(...arguments); - this._reader = new stream_2.default(this._settings); - } - read(task) { - const root = this._getRootDirectory(task); - const options = this._getReaderOptions(task); - const source = this.api(root, task, options); - const destination = new stream_1.Readable({ objectMode: true, read: () => { } }); - source - .once('error', (error) => destination.emit('error', error)) - .on('data', (entry) => destination.emit('data', options.transform(entry))) - .once('end', () => destination.emit('end')); - destination - .once('close', () => source.destroy()); - return destination; - } - api(root, task, options) { - if (task.dynamic) { - return this._reader.dynamic(root, options); - } - return this._reader.static(task.patterns, options); - } -} -exports.default = ProviderStream; + const ignore = patterns + .slice(index) + .filter(isNegative) + .map(pattern => pattern.slice(1)); + const options = { + ...taskOptions, + ignore: taskOptions.ignore.concat(ignore) + }; -/***/ }), + globTasks.push({pattern, options}); + } -/***/ "../../node_modules/del/node_modules/fast-glob/out/providers/sync.js": -/***/ (function(module, exports, __webpack_require__) { + return globTasks; +}; -"use strict"; +const globDirs = (task, fn) => { + let options = {}; + if (task.options.cwd) { + options.cwd = task.options.cwd; + } -Object.defineProperty(exports, "__esModule", { value: true }); -const sync_1 = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/readers/sync.js"); -const provider_1 = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/providers/provider.js"); -class ProviderSync extends provider_1.default { - constructor() { - super(...arguments); - this._reader = new sync_1.default(this._settings); - } - read(task) { - const root = this._getRootDirectory(task); - const options = this._getReaderOptions(task); - const entries = this.api(root, task, options); - return entries.map(options.transform); - } - api(root, task, options) { - if (task.dynamic) { - return this._reader.dynamic(root, options); - } - return this._reader.static(task.patterns, options); - } -} -exports.default = ProviderSync; + if (Array.isArray(task.options.expandDirectories)) { + options = { + ...options, + files: task.options.expandDirectories + }; + } else if (typeof task.options.expandDirectories === 'object') { + options = { + ...options, + ...task.options.expandDirectories + }; + } + return fn(task.pattern, options); +}; -/***/ }), +const getPattern = (task, fn) => task.options.expandDirectories ? globDirs(task, fn) : [task.pattern]; -/***/ "../../node_modules/del/node_modules/fast-glob/out/providers/transformers/entry.js": -/***/ (function(module, exports, __webpack_require__) { +const getFilterSync = options => { + return options && options.gitignore ? + gitignore.sync({cwd: options.cwd, ignore: options.ignore}) : + DEFAULT_FILTER; +}; -"use strict"; +const globToTask = task => glob => { + const {options} = task; + if (options.ignore && Array.isArray(options.ignore) && options.expandDirectories) { + options.ignore = dirGlob.sync(options.ignore); + } -Object.defineProperty(exports, "__esModule", { value: true }); -const utils = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/utils/index.js"); -class EntryTransformer { - constructor(_settings) { - this._settings = _settings; - } - getTransformer() { - return (entry) => this._transform(entry); - } - _transform(entry) { - let filepath = entry.path; - if (this._settings.absolute) { - filepath = utils.path.makeAbsolute(this._settings.cwd, filepath); - filepath = utils.path.unixify(filepath); - } - if (this._settings.markDirectories && entry.dirent.isDirectory()) { - filepath += '/'; - } - if (!this._settings.objectMode) { - return filepath; - } - return Object.assign(Object.assign({}, entry), { path: filepath }); - } -} -exports.default = EntryTransformer; + return { + pattern: glob, + options + }; +}; +module.exports = async (patterns, options) => { + const globTasks = generateGlobTasks(patterns, options); -/***/ }), + const getFilter = async () => { + return options && options.gitignore ? + gitignore({cwd: options.cwd, ignore: options.ignore}) : + DEFAULT_FILTER; + }; -/***/ "../../node_modules/del/node_modules/fast-glob/out/readers/reader.js": -/***/ (function(module, exports, __webpack_require__) { + const getTasks = async () => { + const tasks = await Promise.all(globTasks.map(async task => { + const globs = await getPattern(task, dirGlob); + return Promise.all(globs.map(globToTask(task))); + })); -"use strict"; + return arrayUnion(...tasks); + }; -Object.defineProperty(exports, "__esModule", { value: true }); -const path = __webpack_require__("path"); -const fsStat = __webpack_require__("../../node_modules/@nodelib/fs.stat/out/index.js"); -const utils = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/utils/index.js"); -class Reader { - constructor(_settings) { - this._settings = _settings; - this._fsStatSettings = new fsStat.Settings({ - followSymbolicLink: this._settings.followSymbolicLinks, - fs: this._settings.fs, - throwErrorOnBrokenSymbolicLink: this._settings.followSymbolicLinks - }); - } - _getFullEntryPath(filepath) { - return path.resolve(this._settings.cwd, filepath); - } - _makeEntry(stats, pattern) { - const entry = { - name: pattern, - path: pattern, - dirent: utils.fs.createDirentFromStats(pattern, stats) - }; - if (this._settings.stats) { - entry.stats = stats; - } - return entry; - } - _isFatalError(error) { - return !utils.errno.isEnoentCodeError(error) && !this._settings.suppressErrors; - } -} -exports.default = Reader; + const [filter, tasks] = await Promise.all([getFilter(), getTasks()]); + const paths = await Promise.all(tasks.map(task => fastGlob(task.pattern, task.options))); + return arrayUnion(...paths).filter(path_ => !filter(getPathString(path_))); +}; -/***/ }), +module.exports.sync = (patterns, options) => { + const globTasks = generateGlobTasks(patterns, options); -/***/ "../../node_modules/del/node_modules/fast-glob/out/readers/stream.js": -/***/ (function(module, exports, __webpack_require__) { + const tasks = globTasks.reduce((tasks, task) => { + const newTask = getPattern(task, dirGlob.sync).map(globToTask(task)); + return tasks.concat(newTask); + }, []); -"use strict"; + const filter = getFilterSync(options); -Object.defineProperty(exports, "__esModule", { value: true }); -const stream_1 = __webpack_require__("stream"); -const fsStat = __webpack_require__("../../node_modules/@nodelib/fs.stat/out/index.js"); -const fsWalk = __webpack_require__("../../node_modules/@nodelib/fs.walk/out/index.js"); -const reader_1 = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/readers/reader.js"); -class ReaderStream extends reader_1.default { - constructor() { - super(...arguments); - this._walkStream = fsWalk.walkStream; - this._stat = fsStat.stat; - } - dynamic(root, options) { - return this._walkStream(root, options); - } - static(patterns, options) { - const filepaths = patterns.map(this._getFullEntryPath, this); - const stream = new stream_1.PassThrough({ objectMode: true }); - stream._write = (index, _enc, done) => { - return this._getEntry(filepaths[index], patterns[index], options) - .then((entry) => { - if (entry !== null && options.entryFilter(entry)) { - stream.push(entry); - } - if (index === filepaths.length - 1) { - stream.end(); - } - done(); - }) - .catch(done); - }; - for (let i = 0; i < filepaths.length; i++) { - stream.write(i); - } - return stream; - } - _getEntry(filepath, pattern, options) { - return this._getStat(filepath) - .then((stats) => this._makeEntry(stats, pattern)) - .catch((error) => { - if (options.errorFilter(error)) { - return null; - } - throw error; - }); - } - _getStat(filepath) { - return new Promise((resolve, reject) => { - this._stat(filepath, this._fsStatSettings, (error, stats) => { - return error === null ? resolve(stats) : reject(error); - }); - }); - } -} -exports.default = ReaderStream; + return tasks.reduce( + (matches, task) => arrayUnion(matches, fastGlob.sync(task.pattern, task.options)), + [] + ).filter(path_ => !filter(path_)); +}; +module.exports.stream = (patterns, options) => { + const globTasks = generateGlobTasks(patterns, options); -/***/ }), + const tasks = globTasks.reduce((tasks, task) => { + const newTask = getPattern(task, dirGlob.sync).map(globToTask(task)); + return tasks.concat(newTask); + }, []); -/***/ "../../node_modules/del/node_modules/fast-glob/out/readers/sync.js": -/***/ (function(module, exports, __webpack_require__) { + const filter = getFilterSync(options); + const filterStream = new FilterStream(p => !filter(p)); + const uniqueStream = new UniqueStream(); -"use strict"; + return merge2(tasks.map(task => fastGlob.stream(task.pattern, task.options))) + .pipe(filterStream) + .pipe(uniqueStream); +}; -Object.defineProperty(exports, "__esModule", { value: true }); -const fsStat = __webpack_require__("../../node_modules/@nodelib/fs.stat/out/index.js"); -const fsWalk = __webpack_require__("../../node_modules/@nodelib/fs.walk/out/index.js"); -const reader_1 = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/readers/reader.js"); -class ReaderSync extends reader_1.default { - constructor() { - super(...arguments); - this._walkSync = fsWalk.walkSync; - this._statSync = fsStat.statSync; - } - dynamic(root, options) { - return this._walkSync(root, options); - } - static(patterns, options) { - const entries = []; - for (const pattern of patterns) { - const filepath = this._getFullEntryPath(pattern); - const entry = this._getEntry(filepath, pattern, options); - if (entry === null || !options.entryFilter(entry)) { - continue; - } - entries.push(entry); - } - return entries; - } - _getEntry(filepath, pattern, options) { - try { - const stats = this._getStat(filepath); - return this._makeEntry(stats, pattern); - } - catch (error) { - if (options.errorFilter(error)) { - return null; - } - throw error; - } - } - _getStat(filepath) { - return this._statSync(filepath, this._fsStatSettings); - } -} -exports.default = ReaderSync; +module.exports.generateGlobTasks = generateGlobTasks; + +module.exports.hasMagic = (patterns, options) => [] + .concat(patterns) + .some(pattern => glob.hasMagic(pattern, options)); + +module.exports.gitignore = gitignore; /***/ }), -/***/ "../../node_modules/del/node_modules/fast-glob/out/settings.js": +/***/ "../../node_modules/del/node_modules/globby/stream-utils.js": /***/ (function(module, exports, __webpack_require__) { "use strict"; -Object.defineProperty(exports, "__esModule", { value: true }); -exports.DEFAULT_FILE_SYSTEM_ADAPTER = void 0; -const fs = __webpack_require__("fs"); -const os = __webpack_require__("os"); -/** - * The `os.cpus` method can return zero. We expect the number of cores to be greater than zero. - * https://github.com/nodejs/node/blob/7faeddf23a98c53896f8b574a6e66589e8fb1eb8/lib/os.js#L106-L107 - */ -const CPU_COUNT = Math.max(os.cpus().length, 1); -exports.DEFAULT_FILE_SYSTEM_ADAPTER = { - lstat: fs.lstat, - lstatSync: fs.lstatSync, - stat: fs.stat, - statSync: fs.statSync, - readdir: fs.readdir, - readdirSync: fs.readdirSync -}; -class Settings { - constructor(_options = {}) { - this._options = _options; - this.absolute = this._getValue(this._options.absolute, false); - this.baseNameMatch = this._getValue(this._options.baseNameMatch, false); - this.braceExpansion = this._getValue(this._options.braceExpansion, true); - this.caseSensitiveMatch = this._getValue(this._options.caseSensitiveMatch, true); - this.concurrency = this._getValue(this._options.concurrency, CPU_COUNT); - this.cwd = this._getValue(this._options.cwd, process.cwd()); - this.deep = this._getValue(this._options.deep, Infinity); - this.dot = this._getValue(this._options.dot, false); - this.extglob = this._getValue(this._options.extglob, true); - this.followSymbolicLinks = this._getValue(this._options.followSymbolicLinks, true); - this.fs = this._getFileSystemMethods(this._options.fs); - this.globstar = this._getValue(this._options.globstar, true); - this.ignore = this._getValue(this._options.ignore, []); - this.markDirectories = this._getValue(this._options.markDirectories, false); - this.objectMode = this._getValue(this._options.objectMode, false); - this.onlyDirectories = this._getValue(this._options.onlyDirectories, false); - this.onlyFiles = this._getValue(this._options.onlyFiles, true); - this.stats = this._getValue(this._options.stats, false); - this.suppressErrors = this._getValue(this._options.suppressErrors, false); - this.throwErrorOnBrokenSymbolicLink = this._getValue(this._options.throwErrorOnBrokenSymbolicLink, false); - this.unique = this._getValue(this._options.unique, true); - if (this.onlyDirectories) { - this.onlyFiles = false; - } - if (this.stats) { - this.objectMode = true; - } - } - _getValue(option, value) { - return option === undefined ? value : option; - } - _getFileSystemMethods(methods = {}) { - return Object.assign(Object.assign({}, exports.DEFAULT_FILE_SYSTEM_ADAPTER), methods); - } +const {Transform} = __webpack_require__("stream"); + +class ObjectTransform extends Transform { + constructor() { + super({ + objectMode: true + }); + } } -exports.default = Settings; +class FilterStream extends ObjectTransform { + constructor(filter) { + super(); + this._filter = filter; + } -/***/ }), + _transform(data, encoding, callback) { + if (this._filter(data)) { + this.push(data); + } -/***/ "../../node_modules/del/node_modules/fast-glob/out/utils/array.js": -/***/ (function(module, exports, __webpack_require__) { + callback(); + } +} -"use strict"; +class UniqueStream extends ObjectTransform { + constructor() { + super(); + this._pushed = new Set(); + } -Object.defineProperty(exports, "__esModule", { value: true }); -exports.splitWhen = exports.flatten = void 0; -function flatten(items) { - return items.reduce((collection, item) => [].concat(collection, item), []); -} -exports.flatten = flatten; -function splitWhen(items, predicate) { - const result = [[]]; - let groupIndex = 0; - for (const item of items) { - if (predicate(item)) { - groupIndex++; - result[groupIndex] = []; - } - else { - result[groupIndex].push(item); - } - } - return result; + _transform(data, encoding, callback) { + if (!this._pushed.has(data)) { + this.push(data); + this._pushed.add(data); + } + + callback(); + } } -exports.splitWhen = splitWhen; + +module.exports = { + FilterStream, + UniqueStream +}; /***/ }), -/***/ "../../node_modules/del/node_modules/fast-glob/out/utils/errno.js": +/***/ "../../node_modules/del/node_modules/indent-string/index.js": /***/ (function(module, exports, __webpack_require__) { "use strict"; -Object.defineProperty(exports, "__esModule", { value: true }); -exports.isEnoentCodeError = void 0; -function isEnoentCodeError(error) { - return error.code === 'ENOENT'; -} -exports.isEnoentCodeError = isEnoentCodeError; +module.exports = (string, count = 1, options) => { + options = { + indent: ' ', + includeEmptyLines: false, + ...options + }; -/***/ }), + if (typeof string !== 'string') { + throw new TypeError( + `Expected \`input\` to be a \`string\`, got \`${typeof string}\`` + ); + } -/***/ "../../node_modules/del/node_modules/fast-glob/out/utils/fs.js": -/***/ (function(module, exports, __webpack_require__) { + if (typeof count !== 'number') { + throw new TypeError( + `Expected \`count\` to be a \`number\`, got \`${typeof count}\`` + ); + } -"use strict"; + if (typeof options.indent !== 'string') { + throw new TypeError( + `Expected \`options.indent\` to be a \`string\`, got \`${typeof options.indent}\`` + ); + } -Object.defineProperty(exports, "__esModule", { value: true }); -exports.createDirentFromStats = void 0; -class DirentFromStats { - constructor(name, stats) { - this.name = name; - this.isBlockDevice = stats.isBlockDevice.bind(stats); - this.isCharacterDevice = stats.isCharacterDevice.bind(stats); - this.isDirectory = stats.isDirectory.bind(stats); - this.isFIFO = stats.isFIFO.bind(stats); - this.isFile = stats.isFile.bind(stats); - this.isSocket = stats.isSocket.bind(stats); - this.isSymbolicLink = stats.isSymbolicLink.bind(stats); - } -} -function createDirentFromStats(name, stats) { - return new DirentFromStats(name, stats); -} -exports.createDirentFromStats = createDirentFromStats; + if (count === 0) { + return string; + } + + const regex = options.includeEmptyLines ? /^/gm : /^(?!\s*$)/gm; + + return string.replace(regex, options.indent.repeat(count)); +}; /***/ }), -/***/ "../../node_modules/del/node_modules/fast-glob/out/utils/index.js": +/***/ "../../node_modules/del/node_modules/p-map/index.js": /***/ (function(module, exports, __webpack_require__) { "use strict"; -Object.defineProperty(exports, "__esModule", { value: true }); -exports.string = exports.stream = exports.pattern = exports.path = exports.fs = exports.errno = exports.array = void 0; -const array = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/utils/array.js"); -exports.array = array; -const errno = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/utils/errno.js"); -exports.errno = errno; -const fs = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/utils/fs.js"); -exports.fs = fs; -const path = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/utils/path.js"); -exports.path = path; -const pattern = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/utils/pattern.js"); -exports.pattern = pattern; -const stream = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/utils/stream.js"); -exports.stream = stream; -const string = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/utils/string.js"); -exports.string = string; +const AggregateError = __webpack_require__("../../node_modules/del/node_modules/aggregate-error/index.js"); +module.exports = async ( + iterable, + mapper, + { + concurrency = Infinity, + stopOnError = true + } = {} +) => { + return new Promise((resolve, reject) => { + if (typeof mapper !== 'function') { + throw new TypeError('Mapper function is required'); + } -/***/ }), + if (!(typeof concurrency === 'number' && concurrency >= 1)) { + throw new TypeError(`Expected \`concurrency\` to be a number from 1 and up, got \`${concurrency}\` (${typeof concurrency})`); + } -/***/ "../../node_modules/del/node_modules/fast-glob/out/utils/path.js": -/***/ (function(module, exports, __webpack_require__) { + const ret = []; + const errors = []; + const iterator = iterable[Symbol.iterator](); + let isRejected = false; + let isIterableDone = false; + let resolvingCount = 0; + let currentIndex = 0; -"use strict"; + const next = () => { + if (isRejected) { + return; + } -Object.defineProperty(exports, "__esModule", { value: true }); -exports.removeLeadingDotSegment = exports.escape = exports.makeAbsolute = exports.unixify = void 0; -const path = __webpack_require__("path"); -const LEADING_DOT_SEGMENT_CHARACTERS_COUNT = 2; // ./ or .\\ -const UNESCAPED_GLOB_SYMBOLS_RE = /(\\?)([()*?[\]{|}]|^!|[!+@](?=\())/g; -/** - * Designed to work only with simple paths: `dir\\file`. - */ -function unixify(filepath) { - return filepath.replace(/\\/g, '/'); -} -exports.unixify = unixify; -function makeAbsolute(cwd, filepath) { - return path.resolve(cwd, filepath); -} -exports.makeAbsolute = makeAbsolute; -function escape(pattern) { - return pattern.replace(UNESCAPED_GLOB_SYMBOLS_RE, '\\$2'); -} -exports.escape = escape; -function removeLeadingDotSegment(entry) { - // We do not use `startsWith` because this is 10x slower than current implementation for some cases. - // eslint-disable-next-line @typescript-eslint/prefer-string-starts-ends-with - if (entry.charAt(0) === '.') { - const secondCharactery = entry.charAt(1); - if (secondCharactery === '/' || secondCharactery === '\\') { - return entry.slice(LEADING_DOT_SEGMENT_CHARACTERS_COUNT); - } - } - return entry; -} -exports.removeLeadingDotSegment = removeLeadingDotSegment; + const nextItem = iterator.next(); + const i = currentIndex; + currentIndex++; + + if (nextItem.done) { + isIterableDone = true; + + if (resolvingCount === 0) { + if (!stopOnError && errors.length !== 0) { + reject(new AggregateError(errors)); + } else { + resolve(ret); + } + } + + return; + } + + resolvingCount++; + + (async () => { + try { + const element = await nextItem.value; + ret[i] = await mapper(element, i); + resolvingCount--; + next(); + } catch (error) { + if (stopOnError) { + isRejected = true; + reject(error); + } else { + errors.push(error); + resolvingCount--; + next(); + } + } + })(); + }; + + for (let i = 0; i < concurrency; i++) { + next(); + + if (isIterableDone) { + break; + } + } + }); +}; /***/ }), -/***/ "../../node_modules/del/node_modules/fast-glob/out/utils/pattern.js": +/***/ "../../node_modules/delayed-stream/lib/delayed_stream.js": /***/ (function(module, exports, __webpack_require__) { -"use strict"; +var Stream = __webpack_require__("stream").Stream; +var util = __webpack_require__("util"); -Object.defineProperty(exports, "__esModule", { value: true }); -exports.matchAny = exports.convertPatternsToRe = exports.makeRe = exports.getPatternParts = exports.expandBraceExpansion = exports.expandPatternsWithBraceExpansion = exports.isAffectDepthOfReadingPattern = exports.endsWithSlashGlobStar = exports.hasGlobStar = exports.getBaseDirectory = exports.isPatternRelatedToParentDirectory = exports.getPatternsOutsideCurrentDirectory = exports.getPatternsInsideCurrentDirectory = exports.getPositivePatterns = exports.getNegativePatterns = exports.isPositivePattern = exports.isNegativePattern = exports.convertToNegativePattern = exports.convertToPositivePattern = exports.isDynamicPattern = exports.isStaticPattern = void 0; -const path = __webpack_require__("path"); -const globParent = __webpack_require__("../../node_modules/glob-parent/index.js"); -const micromatch = __webpack_require__("../../node_modules/del/node_modules/micromatch/index.js"); -const GLOBSTAR = '**'; -const ESCAPE_SYMBOL = '\\'; -const COMMON_GLOB_SYMBOLS_RE = /[*?]|^!/; -const REGEX_CHARACTER_CLASS_SYMBOLS_RE = /\[.*]/; -const REGEX_GROUP_SYMBOLS_RE = /(?:^|[^!*+?@])\(.*\|.*\)/; -const GLOB_EXTENSION_SYMBOLS_RE = /[!*+?@]\(.*\)/; -const BRACE_EXPANSIONS_SYMBOLS_RE = /{.*(?:,|\.\.).*}/; -function isStaticPattern(pattern, options = {}) { - return !isDynamicPattern(pattern, options); -} -exports.isStaticPattern = isStaticPattern; -function isDynamicPattern(pattern, options = {}) { - /** - * A special case with an empty string is necessary for matching patterns that start with a forward slash. - * An empty string cannot be a dynamic pattern. - * For example, the pattern `/lib/*` will be spread into parts: '', 'lib', '*'. - */ - if (pattern === '') { - return false; - } - /** - * When the `caseSensitiveMatch` option is disabled, all patterns must be marked as dynamic, because we cannot check - * filepath directly (without read directory). - */ - if (options.caseSensitiveMatch === false || pattern.includes(ESCAPE_SYMBOL)) { - return true; - } - if (COMMON_GLOB_SYMBOLS_RE.test(pattern) || REGEX_CHARACTER_CLASS_SYMBOLS_RE.test(pattern) || REGEX_GROUP_SYMBOLS_RE.test(pattern)) { - return true; - } - if (options.extglob !== false && GLOB_EXTENSION_SYMBOLS_RE.test(pattern)) { - return true; - } - if (options.braceExpansion !== false && BRACE_EXPANSIONS_SYMBOLS_RE.test(pattern)) { - return true; - } - return false; -} -exports.isDynamicPattern = isDynamicPattern; -function convertToPositivePattern(pattern) { - return isNegativePattern(pattern) ? pattern.slice(1) : pattern; -} -exports.convertToPositivePattern = convertToPositivePattern; -function convertToNegativePattern(pattern) { - return '!' + pattern; -} -exports.convertToNegativePattern = convertToNegativePattern; -function isNegativePattern(pattern) { - return pattern.startsWith('!') && pattern[1] !== '('; -} -exports.isNegativePattern = isNegativePattern; -function isPositivePattern(pattern) { - return !isNegativePattern(pattern); -} -exports.isPositivePattern = isPositivePattern; -function getNegativePatterns(patterns) { - return patterns.filter(isNegativePattern); -} -exports.getNegativePatterns = getNegativePatterns; -function getPositivePatterns(patterns) { - return patterns.filter(isPositivePattern); -} -exports.getPositivePatterns = getPositivePatterns; -/** - * Returns patterns that can be applied inside the current directory. - * - * @example - * // ['./*', '*', 'a/*'] - * getPatternsInsideCurrentDirectory(['./*', '*', 'a/*', '../*', './../*']) - */ -function getPatternsInsideCurrentDirectory(patterns) { - return patterns.filter((pattern) => !isPatternRelatedToParentDirectory(pattern)); +module.exports = DelayedStream; +function DelayedStream() { + this.source = null; + this.dataSize = 0; + this.maxDataSize = 1024 * 1024; + this.pauseStream = true; + + this._maxDataSizeExceeded = false; + this._released = false; + this._bufferedEvents = []; } -exports.getPatternsInsideCurrentDirectory = getPatternsInsideCurrentDirectory; -/** - * Returns patterns to be expanded relative to (outside) the current directory. - * - * @example - * // ['../*', './../*'] - * getPatternsInsideCurrentDirectory(['./*', '*', 'a/*', '../*', './../*']) - */ -function getPatternsOutsideCurrentDirectory(patterns) { - return patterns.filter(isPatternRelatedToParentDirectory); -} -exports.getPatternsOutsideCurrentDirectory = getPatternsOutsideCurrentDirectory; -function isPatternRelatedToParentDirectory(pattern) { - return pattern.startsWith('..') || pattern.startsWith('./..'); -} -exports.isPatternRelatedToParentDirectory = isPatternRelatedToParentDirectory; -function getBaseDirectory(pattern) { - return globParent(pattern, { flipBackslashes: false }); -} -exports.getBaseDirectory = getBaseDirectory; -function hasGlobStar(pattern) { - return pattern.includes(GLOBSTAR); -} -exports.hasGlobStar = hasGlobStar; -function endsWithSlashGlobStar(pattern) { - return pattern.endsWith('/' + GLOBSTAR); -} -exports.endsWithSlashGlobStar = endsWithSlashGlobStar; -function isAffectDepthOfReadingPattern(pattern) { - const basename = path.basename(pattern); - return endsWithSlashGlobStar(pattern) || isStaticPattern(basename); -} -exports.isAffectDepthOfReadingPattern = isAffectDepthOfReadingPattern; -function expandPatternsWithBraceExpansion(patterns) { - return patterns.reduce((collection, pattern) => { - return collection.concat(expandBraceExpansion(pattern)); - }, []); -} -exports.expandPatternsWithBraceExpansion = expandPatternsWithBraceExpansion; -function expandBraceExpansion(pattern) { - return micromatch.braces(pattern, { - expand: true, - nodupes: true - }); -} -exports.expandBraceExpansion = expandBraceExpansion; -function getPatternParts(pattern, options) { - let { parts } = micromatch.scan(pattern, Object.assign(Object.assign({}, options), { parts: true })); - /** - * The scan method returns an empty array in some cases. - * See micromatch/picomatch#58 for more details. - */ - if (parts.length === 0) { - parts = [pattern]; - } - /** - * The scan method does not return an empty part for the pattern with a forward slash. - * This is another part of micromatch/picomatch#58. - */ - if (parts[0].startsWith('/')) { - parts[0] = parts[0].slice(1); - parts.unshift(''); - } - return parts; -} -exports.getPatternParts = getPatternParts; -function makeRe(pattern, options) { - return micromatch.makeRe(pattern, options); -} -exports.makeRe = makeRe; -function convertPatternsToRe(patterns, options) { - return patterns.map((pattern) => makeRe(pattern, options)); -} -exports.convertPatternsToRe = convertPatternsToRe; -function matchAny(entry, patternsRe) { - return patternsRe.some((patternRe) => patternRe.test(entry)); -} -exports.matchAny = matchAny; - - -/***/ }), - -/***/ "../../node_modules/del/node_modules/fast-glob/out/utils/stream.js": -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - -Object.defineProperty(exports, "__esModule", { value: true }); -exports.merge = void 0; -const merge2 = __webpack_require__("../../node_modules/merge2/index.js"); -function merge(streams) { - const mergedStream = merge2(streams); - streams.forEach((stream) => { - stream.once('error', (error) => mergedStream.emit('error', error)); - }); - mergedStream.once('close', () => propagateCloseEventToSources(streams)); - mergedStream.once('end', () => propagateCloseEventToSources(streams)); - return mergedStream; -} -exports.merge = merge; -function propagateCloseEventToSources(streams) { - streams.forEach((stream) => stream.emit('close')); -} - - -/***/ }), - -/***/ "../../node_modules/del/node_modules/fast-glob/out/utils/string.js": -/***/ (function(module, exports, __webpack_require__) { +util.inherits(DelayedStream, Stream); -"use strict"; +DelayedStream.create = function(source, options) { + var delayedStream = new this(); -Object.defineProperty(exports, "__esModule", { value: true }); -exports.isEmpty = exports.isString = void 0; -function isString(input) { - return typeof input === 'string'; -} -exports.isString = isString; -function isEmpty(input) { - return input === ''; -} -exports.isEmpty = isEmpty; + options = options || {}; + for (var option in options) { + delayedStream[option] = options[option]; + } + delayedStream.source = source; -/***/ }), + var realEmit = source.emit; + source.emit = function() { + delayedStream._handleEmit(arguments); + return realEmit.apply(source, arguments); + }; -/***/ "../../node_modules/del/node_modules/globby/gitignore.js": -/***/ (function(module, exports, __webpack_require__) { + source.on('error', function() {}); + if (delayedStream.pauseStream) { + source.pause(); + } -"use strict"; + return delayedStream; +}; -const {promisify} = __webpack_require__("util"); -const fs = __webpack_require__("fs"); -const path = __webpack_require__("path"); -const fastGlob = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/index.js"); -const gitIgnore = __webpack_require__("../../node_modules/ignore/index.js"); -const slash = __webpack_require__("../../node_modules/slash/index.js"); +Object.defineProperty(DelayedStream.prototype, 'readable', { + configurable: true, + enumerable: true, + get: function() { + return this.source.readable; + } +}); -const DEFAULT_IGNORE = [ - '**/node_modules/**', - '**/flow-typed/**', - '**/coverage/**', - '**/.git' -]; +DelayedStream.prototype.setEncoding = function() { + return this.source.setEncoding.apply(this.source, arguments); +}; -const readFileP = promisify(fs.readFile); +DelayedStream.prototype.resume = function() { + if (!this._released) { + this.release(); + } -const mapGitIgnorePatternTo = base => ignore => { - if (ignore.startsWith('!')) { - return '!' + path.posix.join(base, ignore.slice(1)); - } + this.source.resume(); +}; - return path.posix.join(base, ignore); +DelayedStream.prototype.pause = function() { + this.source.pause(); }; -const parseGitIgnore = (content, options) => { - const base = slash(path.relative(options.cwd, path.dirname(options.fileName))); +DelayedStream.prototype.release = function() { + this._released = true; - return content - .split(/\r?\n/) - .filter(Boolean) - .filter(line => !line.startsWith('#')) - .map(mapGitIgnorePatternTo(base)); + this._bufferedEvents.forEach(function(args) { + this.emit.apply(this, args); + }.bind(this)); + this._bufferedEvents = []; }; -const reduceIgnore = files => { - return files.reduce((ignores, file) => { - ignores.add(parseGitIgnore(file.content, { - cwd: file.cwd, - fileName: file.filePath - })); - return ignores; - }, gitIgnore()); +DelayedStream.prototype.pipe = function() { + var r = Stream.prototype.pipe.apply(this, arguments); + this.resume(); + return r; }; -const ensureAbsolutePathForCwd = (cwd, p) => { - if (path.isAbsolute(p)) { - if (p.startsWith(cwd)) { - return p; - } +DelayedStream.prototype._handleEmit = function(args) { + if (this._released) { + this.emit.apply(this, args); + return; + } - throw new Error(`Path ${p} is not in cwd ${cwd}`); - } + if (args[0] === 'data') { + this.dataSize += args[1].length; + this._checkIfMaxDataSizeExceeded(); + } - return path.join(cwd, p); + this._bufferedEvents.push(args); }; -const getIsIgnoredPredecate = (ignores, cwd) => { - return p => ignores.ignores(slash(path.relative(cwd, ensureAbsolutePathForCwd(cwd, p)))); -}; +DelayedStream.prototype._checkIfMaxDataSizeExceeded = function() { + if (this._maxDataSizeExceeded) { + return; + } -const getFile = async (file, cwd) => { - const filePath = path.join(cwd, file); - const content = await readFileP(filePath, 'utf8'); + if (this.dataSize <= this.maxDataSize) { + return; + } - return { - cwd, - filePath, - content - }; + this._maxDataSizeExceeded = true; + var message = + 'DelayedStream#maxDataSize of ' + this.maxDataSize + ' bytes exceeded.' + this.emit('error', new Error(message)); }; -const getFileSync = (file, cwd) => { - const filePath = path.join(cwd, file); - const content = fs.readFileSync(filePath, 'utf8'); - return { - cwd, - filePath, - content - }; -}; +/***/ }), -const normalizeOptions = ({ - ignore = [], - cwd = slash(process.cwd()) -} = {}) => { - return {ignore, cwd}; -}; +/***/ "../../node_modules/detect-indent/index.js": +/***/ (function(module, exports, __webpack_require__) { -module.exports = async options => { - options = normalizeOptions(options); +"use strict"; - const paths = await fastGlob('**/.gitignore', { - ignore: DEFAULT_IGNORE.concat(options.ignore), - cwd: options.cwd - }); - const files = await Promise.all(paths.map(file => getFile(file, options.cwd))); - const ignores = reduceIgnore(files); +// Detect either spaces or tabs but not both to properly handle tabs for indentation and spaces for alignment +const INDENT_REGEX = /^(?:( )+|\t+)/; - return getIsIgnoredPredecate(ignores, options.cwd); -}; +const INDENT_TYPE_SPACE = 'space'; +const INDENT_TYPE_TAB = 'tab'; -module.exports.sync = options => { - options = normalizeOptions(options); +// Make a Map that counts how many indents/unindents have occurred for a given size and how many lines follow a given indentation. +// The key is a concatenation of the indentation type (s = space and t = tab) and the size of the indents/unindents. +// +// indents = { +// t3: [1, 0], +// t4: [1, 5], +// s5: [1, 0], +// s12: [1, 0], +// } +function makeIndentsMap(string, ignoreSingleSpaces) { + const indents = new Map(); - const paths = fastGlob.sync('**/.gitignore', { - ignore: DEFAULT_IGNORE.concat(options.ignore), - cwd: options.cwd - }); + // Remember the size of previous line's indentation + let previousSize = 0; + let previousIndentType; - const files = paths.map(file => getFileSync(file, options.cwd)); - const ignores = reduceIgnore(files); + // Indents key (ident type + size of the indents/unindents) + let key; - return getIsIgnoredPredecate(ignores, options.cwd); -}; + for (const line of string.split(/\n/g)) { + if (!line) { + // Ignore empty lines + continue; + } + let indent; + let indentType; + let weight; + let entry; + const matches = line.match(INDENT_REGEX); -/***/ }), + if (matches === null) { + previousSize = 0; + previousIndentType = ''; + } else { + indent = matches[0].length; -/***/ "../../node_modules/del/node_modules/globby/index.js": -/***/ (function(module, exports, __webpack_require__) { + if (matches[1]) { + indentType = INDENT_TYPE_SPACE; + } else { + indentType = INDENT_TYPE_TAB; + } -"use strict"; + // Ignore single space unless it's the only indent detected to prevent common false positives + if (ignoreSingleSpaces && indentType === INDENT_TYPE_SPACE && indent === 1) { + continue; + } -const fs = __webpack_require__("fs"); -const arrayUnion = __webpack_require__("../../node_modules/array-union/index.js"); -const merge2 = __webpack_require__("../../node_modules/merge2/index.js"); -const glob = __webpack_require__("../../node_modules/glob/glob.js"); -const fastGlob = __webpack_require__("../../node_modules/del/node_modules/fast-glob/out/index.js"); -const dirGlob = __webpack_require__("../../node_modules/dir-glob/index.js"); -const gitignore = __webpack_require__("../../node_modules/del/node_modules/globby/gitignore.js"); -const {FilterStream, UniqueStream} = __webpack_require__("../../node_modules/del/node_modules/globby/stream-utils.js"); + if (indentType !== previousIndentType) { + previousSize = 0; + } -const DEFAULT_FILTER = () => false; + previousIndentType = indentType; -const isNegative = pattern => pattern[0] === '!'; + weight = 0; -const assertPatternsInput = patterns => { - if (!patterns.every(pattern => typeof pattern === 'string')) { - throw new TypeError('Patterns must be a string or an array of strings'); - } -}; + const indentDifference = indent - previousSize; + previousSize = indent; -const checkCwdOption = (options = {}) => { - if (!options.cwd) { - return; - } + // Previous line have same indent? + if (indentDifference === 0) { + weight++; + // We use the key from previous loop + } else { + const absoluteIndentDifference = indentDifference > 0 ? indentDifference : -indentDifference; + key = encodeIndentsKey(indentType, absoluteIndentDifference); + } - let stat; - try { - stat = fs.statSync(options.cwd); - } catch (_) { - return; - } + // Update the stats + entry = indents.get(key); - if (!stat.isDirectory()) { - throw new Error('The `cwd` option must be a path to a directory'); - } -}; + if (entry === undefined) { + entry = [1, 0]; // Init + } else { + entry = [++entry[0], entry[1] + weight]; + } -const getPathString = p => p.stats instanceof fs.Stats ? p.path : p; + indents.set(key, entry); + } + } -const generateGlobTasks = (patterns, taskOptions) => { - patterns = arrayUnion([].concat(patterns)); - assertPatternsInput(patterns); - checkCwdOption(taskOptions); + return indents; +} - const globTasks = []; +// Encode the indent type and amount as a string (e.g. 's4') for use as a compound key in the indents Map. +function encodeIndentsKey(indentType, indentAmount) { + const typeCharacter = indentType === INDENT_TYPE_SPACE ? 's' : 't'; + return typeCharacter + String(indentAmount); +} - taskOptions = { - ignore: [], - expandDirectories: true, - ...taskOptions - }; +// Extract the indent type and amount from a key of the indents Map. +function decodeIndentsKey(indentsKey) { + const keyHasTypeSpace = indentsKey[0] === 's'; + const type = keyHasTypeSpace ? INDENT_TYPE_SPACE : INDENT_TYPE_TAB; - for (const [index, pattern] of patterns.entries()) { - if (isNegative(pattern)) { - continue; - } + const amount = Number(indentsKey.slice(1)); - const ignore = patterns - .slice(index) - .filter(isNegative) - .map(pattern => pattern.slice(1)); + return {type, amount}; +} - const options = { - ...taskOptions, - ignore: taskOptions.ignore.concat(ignore) - }; +// Return the key (e.g. 's4') from the indents Map that represents the most common indent, +// or return undefined if there are no indents. +function getMostUsedKey(indents) { + let result; + let maxUsed = 0; + let maxWeight = 0; - globTasks.push({pattern, options}); + for (const [key, [usedCount, weight]] of indents) { + if (usedCount > maxUsed || (usedCount === maxUsed && weight > maxWeight)) { + maxUsed = usedCount; + maxWeight = weight; + result = key; + } } - return globTasks; -}; + return result; +} -const globDirs = (task, fn) => { - let options = {}; - if (task.options.cwd) { - options.cwd = task.options.cwd; - } +function makeIndentString(type, amount) { + const indentCharacter = type === INDENT_TYPE_SPACE ? ' ' : '\t'; + return indentCharacter.repeat(amount); +} - if (Array.isArray(task.options.expandDirectories)) { - options = { - ...options, - files: task.options.expandDirectories - }; - } else if (typeof task.options.expandDirectories === 'object') { - options = { - ...options, - ...task.options.expandDirectories - }; +module.exports = string => { + if (typeof string !== 'string') { + throw new TypeError('Expected a string'); } - return fn(task.pattern, options); -}; + // Identify indents while skipping single space indents to avoid common edge cases (e.g. code comments) + // If no indents are identified, run again and include all indents for comprehensive detection + let indents = makeIndentsMap(string, true); + if (indents.size === 0) { + indents = makeIndentsMap(string, false); + } -const getPattern = (task, fn) => task.options.expandDirectories ? globDirs(task, fn) : [task.pattern]; + const keyOfMostUsedIndent = getMostUsedKey(indents); -const getFilterSync = options => { - return options && options.gitignore ? - gitignore.sync({cwd: options.cwd, ignore: options.ignore}) : - DEFAULT_FILTER; -}; + let type; + let amount = 0; + let indent = ''; -const globToTask = task => glob => { - const {options} = task; - if (options.ignore && Array.isArray(options.ignore) && options.expandDirectories) { - options.ignore = dirGlob.sync(options.ignore); + if (keyOfMostUsedIndent !== undefined) { + ({type, amount} = decodeIndentsKey(keyOfMostUsedIndent)); + indent = makeIndentString(type, amount); } return { - pattern: glob, - options + amount, + type, + indent }; }; -module.exports = async (patterns, options) => { - const globTasks = generateGlobTasks(patterns, options); - const getFilter = async () => { - return options && options.gitignore ? - gitignore({cwd: options.cwd, ignore: options.ignore}) : - DEFAULT_FILTER; - }; +/***/ }), - const getTasks = async () => { - const tasks = await Promise.all(globTasks.map(async task => { - const globs = await getPattern(task, dirGlob); - return Promise.all(globs.map(globToTask(task))); - })); +/***/ "../../node_modules/detect-newline/index.js": +/***/ (function(module, exports, __webpack_require__) { - return arrayUnion(...tasks); - }; +"use strict"; - const [filter, tasks] = await Promise.all([getFilter(), getTasks()]); - const paths = await Promise.all(tasks.map(task => fastGlob(task.pattern, task.options))); - return arrayUnion(...paths).filter(path_ => !filter(getPathString(path_))); -}; +const detectNewline = string => { + if (typeof string !== 'string') { + throw new TypeError('Expected a string'); + } -module.exports.sync = (patterns, options) => { - const globTasks = generateGlobTasks(patterns, options); + const newlines = string.match(/(?:\r?\n)/g) || []; - const tasks = globTasks.reduce((tasks, task) => { - const newTask = getPattern(task, dirGlob.sync).map(globToTask(task)); - return tasks.concat(newTask); - }, []); - - const filter = getFilterSync(options); - - return tasks.reduce( - (matches, task) => arrayUnion(matches, fastGlob.sync(task.pattern, task.options)), - [] - ).filter(path_ => !filter(path_)); -}; - -module.exports.stream = (patterns, options) => { - const globTasks = generateGlobTasks(patterns, options); - - const tasks = globTasks.reduce((tasks, task) => { - const newTask = getPattern(task, dirGlob.sync).map(globToTask(task)); - return tasks.concat(newTask); - }, []); + if (newlines.length === 0) { + return; + } - const filter = getFilterSync(options); - const filterStream = new FilterStream(p => !filter(p)); - const uniqueStream = new UniqueStream(); + const crlf = newlines.filter(newline => newline === '\r\n').length; + const lf = newlines.length - crlf; - return merge2(tasks.map(task => fastGlob.stream(task.pattern, task.options))) - .pipe(filterStream) - .pipe(uniqueStream); + return crlf > lf ? '\r\n' : '\n'; }; -module.exports.generateGlobTasks = generateGlobTasks; - -module.exports.hasMagic = (patterns, options) => [] - .concat(patterns) - .some(pattern => glob.hasMagic(pattern, options)); - -module.exports.gitignore = gitignore; +module.exports = detectNewline; +module.exports.graceful = string => (typeof string === 'string' && detectNewline(string)) || '\n'; /***/ }), -/***/ "../../node_modules/del/node_modules/globby/stream-utils.js": +/***/ "../../node_modules/dir-glob/index.js": /***/ (function(module, exports, __webpack_require__) { "use strict"; -const {Transform} = __webpack_require__("stream"); +const path = __webpack_require__("path"); +const pathType = __webpack_require__("../../node_modules/path-type/index.js"); -class ObjectTransform extends Transform { - constructor() { - super({ - objectMode: true - }); - } -} +const getExtensions = extensions => extensions.length > 1 ? `{${extensions.join(',')}}` : extensions[0]; -class FilterStream extends ObjectTransform { - constructor(filter) { - super(); - this._filter = filter; +const getPath = (filepath, cwd) => { + const pth = filepath[0] === '!' ? filepath.slice(1) : filepath; + return path.isAbsolute(pth) ? pth : path.join(cwd, pth); +}; + +const addExtensions = (file, extensions) => { + if (path.extname(file)) { + return `**/${file}`; } - _transform(data, encoding, callback) { - if (this._filter(data)) { - this.push(data); - } + return `**/${file}.${getExtensions(extensions)}`; +}; - callback(); +const getGlob = (directory, options) => { + if (options.files && !Array.isArray(options.files)) { + throw new TypeError(`Expected \`files\` to be of type \`Array\` but received type \`${typeof options.files}\``); } -} -class UniqueStream extends ObjectTransform { - constructor() { - super(); - this._pushed = new Set(); + if (options.extensions && !Array.isArray(options.extensions)) { + throw new TypeError(`Expected \`extensions\` to be of type \`Array\` but received type \`${typeof options.extensions}\``); } - _transform(data, encoding, callback) { - if (!this._pushed.has(data)) { - this.push(data); - this._pushed.add(data); - } - - callback(); + if (options.files && options.extensions) { + return options.files.map(x => path.posix.join(directory, addExtensions(x, options.extensions))); } -} - -module.exports = { - FilterStream, - UniqueStream -}; - - -/***/ }), -/***/ "../../node_modules/del/node_modules/indent-string/index.js": -/***/ (function(module, exports, __webpack_require__) { + if (options.files) { + return options.files.map(x => path.posix.join(directory, `**/${x}`)); + } -"use strict"; + if (options.extensions) { + return [path.posix.join(directory, `**/*.${getExtensions(options.extensions)}`)]; + } + return [path.posix.join(directory, '**')]; +}; -module.exports = (string, count = 1, options) => { +module.exports = async (input, options) => { options = { - indent: ' ', - includeEmptyLines: false, + cwd: process.cwd(), ...options }; - if (typeof string !== 'string') { - throw new TypeError( - `Expected \`input\` to be a \`string\`, got \`${typeof string}\`` - ); + if (typeof options.cwd !== 'string') { + throw new TypeError(`Expected \`cwd\` to be of type \`string\` but received type \`${typeof options.cwd}\``); } - if (typeof count !== 'number') { - throw new TypeError( - `Expected \`count\` to be a \`number\`, got \`${typeof count}\`` - ); - } + const globs = await Promise.all([].concat(input).map(async x => { + const isDirectory = await pathType.isDirectory(getPath(x, options.cwd)); + return isDirectory ? getGlob(x, options) : x; + })); - if (typeof options.indent !== 'string') { - throw new TypeError( - `Expected \`options.indent\` to be a \`string\`, got \`${typeof options.indent}\`` - ); - } + return [].concat.apply([], globs); // eslint-disable-line prefer-spread +}; - if (count === 0) { - return string; +module.exports.sync = (input, options) => { + options = { + cwd: process.cwd(), + ...options + }; + + if (typeof options.cwd !== 'string') { + throw new TypeError(`Expected \`cwd\` to be of type \`string\` but received type \`${typeof options.cwd}\``); } - const regex = options.includeEmptyLines ? /^/gm : /^(?!\s*$)/gm; + const globs = [].concat(input).map(x => pathType.isDirectorySync(getPath(x, options.cwd)) ? getGlob(x, options) : x); - return string.replace(regex, options.indent.repeat(count)); + return [].concat.apply([], globs); // eslint-disable-line prefer-spread }; /***/ }), -/***/ "../../node_modules/del/node_modules/micromatch/index.js": +/***/ "../../node_modules/duplexer/index.js": /***/ (function(module, exports, __webpack_require__) { -"use strict"; - +var Stream = __webpack_require__("stream") +var writeMethods = ["write", "end", "destroy"] +var readMethods = ["resume", "pause"] +var readEvents = ["data", "close"] +var slice = Array.prototype.slice -const util = __webpack_require__("util"); -const braces = __webpack_require__("../../node_modules/braces/index.js"); -const picomatch = __webpack_require__("../../node_modules/picomatch/index.js"); -const utils = __webpack_require__("../../node_modules/picomatch/lib/utils.js"); -const isEmptyString = val => val === '' || val === './'; +module.exports = duplex -/** - * Returns an array of strings that match one or more glob patterns. - * - * ```js - * const mm = require('micromatch'); - * // mm(list, patterns[, options]); - * - * console.log(mm(['a.js', 'a.txt'], ['*.js'])); - * //=> [ 'a.js' ] - * ``` - * @param {String|Array} `list` List of strings to match. - * @param {String|Array} `patterns` One or more glob patterns to use for matching. - * @param {Object} `options` See available [options](#options) - * @return {Array} Returns an array of matches - * @summary false - * @api public - */ +function forEach (arr, fn) { + if (arr.forEach) { + return arr.forEach(fn) + } -const micromatch = (list, patterns, options) => { - patterns = [].concat(patterns); - list = [].concat(list); + for (var i = 0; i < arr.length; i++) { + fn(arr[i], i) + } +} - let omit = new Set(); - let keep = new Set(); - let items = new Set(); - let negatives = 0; +function duplex(writer, reader) { + var stream = new Stream() + var ended = false - let onResult = state => { - items.add(state.output); - if (options && options.onResult) { - options.onResult(state); - } - }; + forEach(writeMethods, proxyWriter) - for (let i = 0; i < patterns.length; i++) { - let isMatch = picomatch(String(patterns[i]), { ...options, onResult }, true); - let negated = isMatch.state.negated || isMatch.state.negatedExtglob; - if (negated) negatives++; + forEach(readMethods, proxyReader) - for (let item of list) { - let matched = isMatch(item, true); + forEach(readEvents, proxyStream) - let match = negated ? !matched.isMatch : matched.isMatch; - if (!match) continue; + reader.on("end", handleEnd) - if (negated) { - omit.add(matched.output); - } else { - omit.delete(matched.output); - keep.add(matched.output); - } - } - } + writer.on("drain", function() { + stream.emit("drain") + }) - let result = negatives === patterns.length ? [...items] : [...keep]; - let matches = result.filter(item => !omit.has(item)); + writer.on("error", reemit) + reader.on("error", reemit) - if (options && matches.length === 0) { - if (options.failglob === true) { - throw new Error(`No matches found for "${patterns.join(', ')}"`); - } + stream.writable = writer.writable + stream.readable = reader.readable - if (options.nonull === true || options.nullglob === true) { - return options.unescape ? patterns.map(p => p.replace(/\\/g, '')) : patterns; - } - } + return stream - return matches; -}; + function proxyWriter(methodName) { + stream[methodName] = method -/** - * Backwards compatibility - */ + function method() { + return writer[methodName].apply(writer, arguments) + } + } -micromatch.match = micromatch; + function proxyReader(methodName) { + stream[methodName] = method -/** - * Returns a matcher function from the given glob `pattern` and `options`. - * The returned function takes a string to match as its only argument and returns - * true if the string is a match. - * - * ```js - * const mm = require('micromatch'); - * // mm.matcher(pattern[, options]); - * - * const isMatch = mm.matcher('*.!(*a)'); - * console.log(isMatch('a.a')); //=> false - * console.log(isMatch('a.b')); //=> true - * ``` - * @param {String} `pattern` Glob pattern - * @param {Object} `options` - * @return {Function} Returns a matcher function. - * @api public - */ + function method() { + stream.emit(methodName) + var func = reader[methodName] + if (func) { + return func.apply(reader, arguments) + } + reader.emit(methodName) + } + } -micromatch.matcher = (pattern, options) => picomatch(pattern, options); + function proxyStream(methodName) { + reader.on(methodName, reemit) -/** - * Returns true if **any** of the given glob `patterns` match the specified `string`. - * - * ```js - * const mm = require('micromatch'); - * // mm.isMatch(string, patterns[, options]); - * - * console.log(mm.isMatch('a.a', ['b.*', '*.a'])); //=> true - * console.log(mm.isMatch('a.a', 'b.*')); //=> false - * ``` - * @param {String} `str` The string to test. - * @param {String|Array} `patterns` One or more glob patterns to use for matching. - * @param {Object} `[options]` See available [options](#options). - * @return {Boolean} Returns true if any patterns match `str` - * @api public - */ + function reemit() { + var args = slice.call(arguments) + args.unshift(methodName) + stream.emit.apply(stream, args) + } + } -micromatch.isMatch = (str, patterns, options) => picomatch(patterns, options)(str); + function handleEnd() { + if (ended) { + return + } + ended = true + var args = slice.call(arguments) + args.unshift("end") + stream.emit.apply(stream, args) + } -/** - * Backwards compatibility - */ + function reemit(err) { + stream.emit("error", err) + } +} -micromatch.any = micromatch.isMatch; -/** - * Returns a list of strings that _**do not match any**_ of the given `patterns`. - * - * ```js - * const mm = require('micromatch'); - * // mm.not(list, patterns[, options]); - * - * console.log(mm.not(['a.a', 'b.b', 'c.c'], '*.a')); - * //=> ['b.b', 'c.c'] - * ``` - * @param {Array} `list` Array of strings to match. - * @param {String|Array} `patterns` One or more glob pattern to use for matching. - * @param {Object} `options` See available [options](#options) for changing how matches are performed - * @return {Array} Returns an array of strings that **do not match** the given patterns. - * @api public - */ +/***/ }), -micromatch.not = (list, patterns, options = {}) => { - patterns = [].concat(patterns).map(String); - let result = new Set(); - let items = []; +/***/ "../../node_modules/end-of-stream/index.js": +/***/ (function(module, exports, __webpack_require__) { - let onResult = state => { - if (options.onResult) options.onResult(state); - items.push(state.output); - }; +var once = __webpack_require__("../../node_modules/once/once.js"); - let matches = micromatch(list, patterns, { ...options, onResult }); +var noop = function() {}; - for (let item of items) { - if (!matches.includes(item)) { - result.add(item); - } - } - return [...result]; +var isRequest = function(stream) { + return stream.setHeader && typeof stream.abort === 'function'; }; -/** - * Returns true if the given `string` contains the given pattern. Similar - * to [.isMatch](#isMatch) but the pattern can match any part of the string. - * - * ```js - * var mm = require('micromatch'); - * // mm.contains(string, pattern[, options]); - * - * console.log(mm.contains('aa/bb/cc', '*b')); - * //=> true - * console.log(mm.contains('aa/bb/cc', '*d')); - * //=> false - * ``` - * @param {String} `str` The string to match. - * @param {String|Array} `patterns` Glob pattern to use for matching. - * @param {Object} `options` See available [options](#options) for changing how matches are performed - * @return {Boolean} Returns true if any of the patterns matches any part of `str`. - * @api public - */ +var isChildProcess = function(stream) { + return stream.stdio && Array.isArray(stream.stdio) && stream.stdio.length === 3 +}; -micromatch.contains = (str, pattern, options) => { - if (typeof str !== 'string') { - throw new TypeError(`Expected a string: "${util.inspect(str)}"`); - } +var eos = function(stream, opts, callback) { + if (typeof opts === 'function') return eos(stream, null, opts); + if (!opts) opts = {}; - if (Array.isArray(pattern)) { - return pattern.some(p => micromatch.contains(str, p, options)); - } + callback = once(callback || noop); - if (typeof pattern === 'string') { - if (isEmptyString(str) || isEmptyString(pattern)) { - return false; - } + var ws = stream._writableState; + var rs = stream._readableState; + var readable = opts.readable || (opts.readable !== false && stream.readable); + var writable = opts.writable || (opts.writable !== false && stream.writable); + var cancelled = false; - if (str.includes(pattern) || (str.startsWith('./') && str.slice(2).includes(pattern))) { - return true; - } - } + var onlegacyfinish = function() { + if (!stream.writable) onfinish(); + }; - return micromatch.isMatch(str, pattern, { ...options, contains: true }); -}; + var onfinish = function() { + writable = false; + if (!readable) callback.call(stream); + }; -/** - * Filter the keys of the given object with the given `glob` pattern - * and `options`. Does not attempt to match nested keys. If you need this feature, - * use [glob-object][] instead. - * - * ```js - * const mm = require('micromatch'); - * // mm.matchKeys(object, patterns[, options]); - * - * const obj = { aa: 'a', ab: 'b', ac: 'c' }; - * console.log(mm.matchKeys(obj, '*b')); - * //=> { ab: 'b' } - * ``` - * @param {Object} `object` The object with keys to filter. - * @param {String|Array} `patterns` One or more glob patterns to use for matching. - * @param {Object} `options` See available [options](#options) for changing how matches are performed - * @return {Object} Returns an object with only keys that match the given patterns. - * @api public - */ + var onend = function() { + readable = false; + if (!writable) callback.call(stream); + }; -micromatch.matchKeys = (obj, patterns, options) => { - if (!utils.isObject(obj)) { - throw new TypeError('Expected the first argument to be an object'); - } - let keys = micromatch(Object.keys(obj), patterns, options); - let res = {}; - for (let key of keys) res[key] = obj[key]; - return res; -}; + var onexit = function(exitCode) { + callback.call(stream, exitCode ? new Error('exited with error code: ' + exitCode) : null); + }; -/** - * Returns true if some of the strings in the given `list` match any of the given glob `patterns`. - * - * ```js - * const mm = require('micromatch'); - * // mm.some(list, patterns[, options]); - * - * console.log(mm.some(['foo.js', 'bar.js'], ['*.js', '!foo.js'])); - * // true - * console.log(mm.some(['foo.js'], ['*.js', '!foo.js'])); - * // false - * ``` - * @param {String|Array} `list` The string or array of strings to test. Returns as soon as the first match is found. - * @param {String|Array} `patterns` One or more glob patterns to use for matching. - * @param {Object} `options` See available [options](#options) for changing how matches are performed - * @return {Boolean} Returns true if any `patterns` matches any of the strings in `list` - * @api public - */ + var onerror = function(err) { + callback.call(stream, err); + }; -micromatch.some = (list, patterns, options) => { - let items = [].concat(list); + var onclose = function() { + process.nextTick(onclosenexttick); + }; - for (let pattern of [].concat(patterns)) { - let isMatch = picomatch(String(pattern), options); - if (items.some(item => isMatch(item))) { - return true; - } - } - return false; -}; + var onclosenexttick = function() { + if (cancelled) return; + if (readable && !(rs && (rs.ended && !rs.destroyed))) return callback.call(stream, new Error('premature close')); + if (writable && !(ws && (ws.ended && !ws.destroyed))) return callback.call(stream, new Error('premature close')); + }; -/** - * Returns true if every string in the given `list` matches - * any of the given glob `patterns`. - * - * ```js - * const mm = require('micromatch'); - * // mm.every(list, patterns[, options]); - * - * console.log(mm.every('foo.js', ['foo.js'])); - * // true - * console.log(mm.every(['foo.js', 'bar.js'], ['*.js'])); - * // true - * console.log(mm.every(['foo.js', 'bar.js'], ['*.js', '!foo.js'])); - * // false - * console.log(mm.every(['foo.js'], ['*.js', '!foo.js'])); - * // false - * ``` - * @param {String|Array} `list` The string or array of strings to test. - * @param {String|Array} `patterns` One or more glob patterns to use for matching. - * @param {Object} `options` See available [options](#options) for changing how matches are performed - * @return {Boolean} Returns true if all `patterns` matches all of the strings in `list` - * @api public - */ - -micromatch.every = (list, patterns, options) => { - let items = [].concat(list); + var onrequest = function() { + stream.req.on('finish', onfinish); + }; - for (let pattern of [].concat(patterns)) { - let isMatch = picomatch(String(pattern), options); - if (!items.every(item => isMatch(item))) { - return false; - } - } - return true; -}; + if (isRequest(stream)) { + stream.on('complete', onfinish); + stream.on('abort', onclose); + if (stream.req) onrequest(); + else stream.on('request', onrequest); + } else if (writable && !ws) { // legacy streams + stream.on('end', onlegacyfinish); + stream.on('close', onlegacyfinish); + } -/** - * Returns true if **all** of the given `patterns` match - * the specified string. - * - * ```js - * const mm = require('micromatch'); - * // mm.all(string, patterns[, options]); - * - * console.log(mm.all('foo.js', ['foo.js'])); - * // true - * - * console.log(mm.all('foo.js', ['*.js', '!foo.js'])); - * // false - * - * console.log(mm.all('foo.js', ['*.js', 'foo.js'])); - * // true - * - * console.log(mm.all('foo.js', ['*.js', 'f*', '*o*', '*o.js'])); - * // true - * ``` - * @param {String|Array} `str` The string to test. - * @param {String|Array} `patterns` One or more glob patterns to use for matching. - * @param {Object} `options` See available [options](#options) for changing how matches are performed - * @return {Boolean} Returns true if any patterns match `str` - * @api public - */ + if (isChildProcess(stream)) stream.on('exit', onexit); -micromatch.all = (str, patterns, options) => { - if (typeof str !== 'string') { - throw new TypeError(`Expected a string: "${util.inspect(str)}"`); - } + stream.on('end', onend); + stream.on('finish', onfinish); + if (opts.error !== false) stream.on('error', onerror); + stream.on('close', onclose); - return [].concat(patterns).every(p => picomatch(p, options)(str)); + return function() { + cancelled = true; + stream.removeListener('complete', onfinish); + stream.removeListener('abort', onclose); + stream.removeListener('request', onrequest); + if (stream.req) stream.req.removeListener('finish', onfinish); + stream.removeListener('end', onlegacyfinish); + stream.removeListener('close', onlegacyfinish); + stream.removeListener('finish', onfinish); + stream.removeListener('exit', onexit); + stream.removeListener('end', onend); + stream.removeListener('error', onerror); + stream.removeListener('close', onclose); + }; }; -/** - * Returns an array of matches captured by `pattern` in `string, or `null` if the pattern did not match. - * - * ```js - * const mm = require('micromatch'); - * // mm.capture(pattern, string[, options]); - * - * console.log(mm.capture('test/*.js', 'test/foo.js')); - * //=> ['foo'] - * console.log(mm.capture('test/*.js', 'foo/bar.css')); - * //=> null - * ``` - * @param {String} `glob` Glob pattern to use for matching. - * @param {String} `input` String to match - * @param {Object} `options` See available [options](#options) for changing how matches are performed - * @return {Array|null} Returns an array of captures if the input matches the glob pattern, otherwise `null`. - * @api public - */ +module.exports = eos; -micromatch.capture = (glob, input, options) => { - let posix = utils.isWindows(options); - let regex = picomatch.makeRe(String(glob), { ...options, capture: true }); - let match = regex.exec(posix ? utils.toPosixSlashes(input) : input); - if (match) { - return match.slice(1).map(v => v === void 0 ? '' : v); - } -}; +/***/ }), -/** - * Create a regular expression from the given glob `pattern`. - * - * ```js - * const mm = require('micromatch'); - * // mm.makeRe(pattern[, options]); - * - * console.log(mm.makeRe('*.js')); - * //=> /^(?:(\.[\\\/])?(?!\.)(?=.)[^\/]*?\.js)$/ - * ``` - * @param {String} `pattern` A glob pattern to convert to regex. - * @param {Object} `options` - * @return {RegExp} Returns a regex created from the given pattern. - * @api public - */ +/***/ "../../node_modules/error-ex/index.js": +/***/ (function(module, exports, __webpack_require__) { -micromatch.makeRe = (...args) => picomatch.makeRe(...args); +"use strict"; -/** - * Scan a glob pattern to separate the pattern into segments. Used - * by the [split](#split) method. - * - * ```js - * const mm = require('micromatch'); - * const state = mm.scan(pattern[, options]); - * ``` - * @param {String} `pattern` - * @param {Object} `options` - * @return {Object} Returns an object with - * @api public - */ -micromatch.scan = (...args) => picomatch.scan(...args); +var util = __webpack_require__("util"); +var isArrayish = __webpack_require__("../../node_modules/is-arrayish/index.js"); -/** - * Parse a glob pattern to create the source string for a regular - * expression. - * - * ```js - * const mm = require('micromatch'); - * const state = mm(pattern[, options]); - * ``` - * @param {String} `glob` - * @param {Object} `options` - * @return {Object} Returns an object with useful properties and output to be used as regex source string. - * @api public - */ +var errorEx = function errorEx(name, properties) { + if (!name || name.constructor !== String) { + properties = name || {}; + name = Error.name; + } -micromatch.parse = (patterns, options) => { - let res = []; - for (let pattern of [].concat(patterns || [])) { - for (let str of braces(String(pattern), options)) { - res.push(picomatch.parse(str, options)); - } - } - return res; -}; + var errorExError = function ErrorEXError(message) { + if (!this) { + return new ErrorEXError(message); + } -/** - * Process the given brace `pattern`. - * - * ```js - * const { braces } = require('micromatch'); - * console.log(braces('foo/{a,b,c}/bar')); - * //=> [ 'foo/(a|b|c)/bar' ] - * - * console.log(braces('foo/{a,b,c}/bar', { expand: true })); - * //=> [ 'foo/a/bar', 'foo/b/bar', 'foo/c/bar' ] - * ``` - * @param {String} `pattern` String with brace pattern to process. - * @param {Object} `options` Any [options](#options) to change how expansion is performed. See the [braces][] library for all available options. - * @return {Array} - * @api public - */ + message = message instanceof Error + ? message.message + : (message || this.message); -micromatch.braces = (pattern, options) => { - if (typeof pattern !== 'string') throw new TypeError('Expected a string'); - if ((options && options.nobrace === true) || !/\{.*\}/.test(pattern)) { - return [pattern]; - } - return braces(pattern, options); -}; + Error.call(this, message); + Error.captureStackTrace(this, errorExError); -/** - * Expand braces - */ + this.name = name; -micromatch.braceExpand = (pattern, options) => { - if (typeof pattern !== 'string') throw new TypeError('Expected a string'); - return micromatch.braces(pattern, { ...options, expand: true }); -}; + Object.defineProperty(this, 'message', { + configurable: true, + enumerable: false, + get: function () { + var newMessage = message.split(/\r?\n/g); -/** - * Expose micromatch - */ + for (var key in properties) { + if (!properties.hasOwnProperty(key)) { + continue; + } -module.exports = micromatch; + var modifier = properties[key]; + if ('message' in modifier) { + newMessage = modifier.message(this[key], newMessage) || newMessage; + if (!isArrayish(newMessage)) { + newMessage = [newMessage]; + } + } + } -/***/ }), + return newMessage.join('\n'); + }, + set: function (v) { + message = v; + } + }); -/***/ "../../node_modules/del/node_modules/p-map/index.js": -/***/ (function(module, exports, __webpack_require__) { + var stackDescriptor = Object.getOwnPropertyDescriptor(this, 'stack'); + var stackGetter = stackDescriptor.get; + var stackValue = stackDescriptor.value; + delete stackDescriptor.value; + delete stackDescriptor.writable; -"use strict"; + stackDescriptor.get = function () { + var stack = (stackGetter) + ? stackGetter.call(this).split(/\r?\n+/g) + : stackValue.split(/\r?\n+/g); -const AggregateError = __webpack_require__("../../node_modules/del/node_modules/aggregate-error/index.js"); + // starting in Node 7, the stack builder caches the message. + // just replace it. + stack[0] = this.name + ': ' + this.message; -module.exports = async ( - iterable, - mapper, - { - concurrency = Infinity, - stopOnError = true - } = {} -) => { - return new Promise((resolve, reject) => { - if (typeof mapper !== 'function') { - throw new TypeError('Mapper function is required'); - } + var lineCount = 1; + for (var key in properties) { + if (!properties.hasOwnProperty(key)) { + continue; + } - if (!(typeof concurrency === 'number' && concurrency >= 1)) { - throw new TypeError(`Expected \`concurrency\` to be a number from 1 and up, got \`${concurrency}\` (${typeof concurrency})`); - } + var modifier = properties[key]; - const ret = []; - const errors = []; - const iterator = iterable[Symbol.iterator](); - let isRejected = false; - let isIterableDone = false; - let resolvingCount = 0; - let currentIndex = 0; + if ('line' in modifier) { + var line = modifier.line(this[key]); + if (line) { + stack.splice(lineCount++, 0, ' ' + line); + } + } - const next = () => { - if (isRejected) { - return; + if ('stack' in modifier) { + modifier.stack(this[key], stack); + } } - const nextItem = iterator.next(); - const i = currentIndex; - currentIndex++; + return stack.join('\n'); + }; - if (nextItem.done) { - isIterableDone = true; + Object.defineProperty(this, 'stack', stackDescriptor); + }; - if (resolvingCount === 0) { - if (!stopOnError && errors.length !== 0) { - reject(new AggregateError(errors)); - } else { - resolve(ret); - } - } + if (Object.setPrototypeOf) { + Object.setPrototypeOf(errorExError.prototype, Error.prototype); + Object.setPrototypeOf(errorExError, Error); + } else { + util.inherits(errorExError, Error); + } - return; - } + return errorExError; +}; - resolvingCount++; +errorEx.append = function (str, def) { + return { + message: function (v, message) { + v = v || def; - (async () => { - try { - const element = await nextItem.value; - ret[i] = await mapper(element, i); - resolvingCount--; - next(); - } catch (error) { - if (stopOnError) { - isRejected = true; - reject(error); - } else { - errors.push(error); - resolvingCount--; - next(); - } - } - })(); - }; + if (v) { + message[0] += ' ' + str.replace('%s', v.toString()); + } - for (let i = 0; i < concurrency; i++) { - next(); + return message; + } + }; +}; - if (isIterableDone) { - break; +errorEx.line = function (str, def) { + return { + line: function (v) { + v = v || def; + + if (v) { + return str.replace('%s', v.toString()); } + + return null; } - }); + }; }; +module.exports = errorEx; + /***/ }), -/***/ "../../node_modules/delayed-stream/lib/delayed_stream.js": +/***/ "../../node_modules/escape-string-regexp/index.js": /***/ (function(module, exports, __webpack_require__) { -var Stream = __webpack_require__("stream").Stream; -var util = __webpack_require__("util"); +"use strict"; -module.exports = DelayedStream; -function DelayedStream() { - this.source = null; - this.dataSize = 0; - this.maxDataSize = 1024 * 1024; - this.pauseStream = true; - this._maxDataSizeExceeded = false; - this._released = false; - this._bufferedEvents = []; -} -util.inherits(DelayedStream, Stream); +var matchOperatorsRe = /[|\\{}()[\]^$+*?.]/g; -DelayedStream.create = function(source, options) { - var delayedStream = new this(); +module.exports = function (str) { + if (typeof str !== 'string') { + throw new TypeError('Expected a string'); + } - options = options || {}; - for (var option in options) { - delayedStream[option] = options[option]; - } + return str.replace(matchOperatorsRe, '\\$&'); +}; - delayedStream.source = source; - var realEmit = source.emit; - source.emit = function() { - delayedStream._handleEmit(arguments); - return realEmit.apply(source, arguments); - }; +/***/ }), - source.on('error', function() {}); - if (delayedStream.pauseStream) { - source.pause(); - } +/***/ "../../node_modules/execa/index.js": +/***/ (function(module, exports, __webpack_require__) { - return delayedStream; -}; +"use strict"; -Object.defineProperty(DelayedStream.prototype, 'readable', { - configurable: true, - enumerable: true, - get: function() { - return this.source.readable; - } -}); +const path = __webpack_require__("path"); +const childProcess = __webpack_require__("child_process"); +const crossSpawn = __webpack_require__("../../node_modules/cross-spawn/index.js"); +const stripFinalNewline = __webpack_require__("../../node_modules/strip-final-newline/index.js"); +const npmRunPath = __webpack_require__("../../node_modules/npm-run-path/index.js"); +const onetime = __webpack_require__("../../node_modules/onetime/index.js"); +const makeError = __webpack_require__("../../node_modules/execa/lib/error.js"); +const normalizeStdio = __webpack_require__("../../node_modules/execa/lib/stdio.js"); +const {spawnedKill, spawnedCancel, setupTimeout, setExitHandler} = __webpack_require__("../../node_modules/execa/lib/kill.js"); +const {handleInput, getSpawnedResult, makeAllStream, validateInputSync} = __webpack_require__("../../node_modules/execa/lib/stream.js"); +const {mergePromise, getSpawnedPromise} = __webpack_require__("../../node_modules/execa/lib/promise.js"); +const {joinCommand, parseCommand} = __webpack_require__("../../node_modules/execa/lib/command.js"); -DelayedStream.prototype.setEncoding = function() { - return this.source.setEncoding.apply(this.source, arguments); -}; +const DEFAULT_MAX_BUFFER = 1000 * 1000 * 100; -DelayedStream.prototype.resume = function() { - if (!this._released) { - this.release(); - } +const getEnv = ({env: envOption, extendEnv, preferLocal, localDir, execPath}) => { + const env = extendEnv ? {...process.env, ...envOption} : envOption; - this.source.resume(); -}; + if (preferLocal) { + return npmRunPath.env({env, cwd: localDir, execPath}); + } -DelayedStream.prototype.pause = function() { - this.source.pause(); + return env; }; -DelayedStream.prototype.release = function() { - this._released = true; +const handleArguments = (file, args, options = {}) => { + const parsed = crossSpawn._parse(file, args, options); + file = parsed.command; + args = parsed.args; + options = parsed.options; - this._bufferedEvents.forEach(function(args) { - this.emit.apply(this, args); - }.bind(this)); - this._bufferedEvents = []; -}; + options = { + maxBuffer: DEFAULT_MAX_BUFFER, + buffer: true, + stripFinalNewline: true, + extendEnv: true, + preferLocal: false, + localDir: options.cwd || process.cwd(), + execPath: process.execPath, + encoding: 'utf8', + reject: true, + cleanup: true, + all: false, + windowsHide: true, + ...options + }; -DelayedStream.prototype.pipe = function() { - var r = Stream.prototype.pipe.apply(this, arguments); - this.resume(); - return r; -}; + options.env = getEnv(options); -DelayedStream.prototype._handleEmit = function(args) { - if (this._released) { - this.emit.apply(this, args); - return; - } + options.stdio = normalizeStdio(options); - if (args[0] === 'data') { - this.dataSize += args[1].length; - this._checkIfMaxDataSizeExceeded(); - } + if (process.platform === 'win32' && path.basename(file, '.exe') === 'cmd') { + // #116 + args.unshift('/q'); + } - this._bufferedEvents.push(args); + return {file, args, options, parsed}; }; -DelayedStream.prototype._checkIfMaxDataSizeExceeded = function() { - if (this._maxDataSizeExceeded) { - return; - } +const handleOutput = (options, value, error) => { + if (typeof value !== 'string' && !Buffer.isBuffer(value)) { + // When `execa.sync()` errors, we normalize it to '' to mimic `execa()` + return error === undefined ? undefined : ''; + } - if (this.dataSize <= this.maxDataSize) { - return; - } + if (options.stripFinalNewline) { + return stripFinalNewline(value); + } - this._maxDataSizeExceeded = true; - var message = - 'DelayedStream#maxDataSize of ' + this.maxDataSize + ' bytes exceeded.' - this.emit('error', new Error(message)); + return value; }; +const execa = (file, args, options) => { + const parsed = handleArguments(file, args, options); + const command = joinCommand(file, args); -/***/ }), - -/***/ "../../node_modules/detect-indent/index.js": -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; + let spawned; + try { + spawned = childProcess.spawn(parsed.file, parsed.args, parsed.options); + } catch (error) { + // Ensure the returned error is always both a promise and a child process + const dummySpawned = new childProcess.ChildProcess(); + const errorPromise = Promise.reject(makeError({ + error, + stdout: '', + stderr: '', + all: '', + command, + parsed, + timedOut: false, + isCanceled: false, + killed: false + })); + return mergePromise(dummySpawned, errorPromise); + } + const spawnedPromise = getSpawnedPromise(spawned); + const timedPromise = setupTimeout(spawned, parsed.options, spawnedPromise); + const processDone = setExitHandler(spawned, parsed.options, timedPromise); -// Detect either spaces or tabs but not both to properly handle tabs for indentation and spaces for alignment -const INDENT_REGEX = /^(?:( )+|\t+)/; + const context = {isCanceled: false}; -const INDENT_TYPE_SPACE = 'space'; -const INDENT_TYPE_TAB = 'tab'; + spawned.kill = spawnedKill.bind(null, spawned.kill.bind(spawned)); + spawned.cancel = spawnedCancel.bind(null, spawned, context); -// Make a Map that counts how many indents/unindents have occurred for a given size and how many lines follow a given indentation. -// The key is a concatenation of the indentation type (s = space and t = tab) and the size of the indents/unindents. -// -// indents = { -// t3: [1, 0], -// t4: [1, 5], -// s5: [1, 0], -// s12: [1, 0], -// } -function makeIndentsMap(string, ignoreSingleSpaces) { - const indents = new Map(); + const handlePromise = async () => { + const [{error, exitCode, signal, timedOut}, stdoutResult, stderrResult, allResult] = await getSpawnedResult(spawned, parsed.options, processDone); + const stdout = handleOutput(parsed.options, stdoutResult); + const stderr = handleOutput(parsed.options, stderrResult); + const all = handleOutput(parsed.options, allResult); - // Remember the size of previous line's indentation - let previousSize = 0; - let previousIndentType; + if (error || exitCode !== 0 || signal !== null) { + const returnedError = makeError({ + error, + exitCode, + signal, + stdout, + stderr, + all, + command, + parsed, + timedOut, + isCanceled: context.isCanceled, + killed: spawned.killed + }); - // Indents key (ident type + size of the indents/unindents) - let key; + if (!parsed.options.reject) { + return returnedError; + } - for (const line of string.split(/\n/g)) { - if (!line) { - // Ignore empty lines - continue; + throw returnedError; } - let indent; - let indentType; - let weight; - let entry; - const matches = line.match(INDENT_REGEX); + return { + command, + exitCode: 0, + stdout, + stderr, + all, + failed: false, + timedOut: false, + isCanceled: false, + killed: false + }; + }; - if (matches === null) { - previousSize = 0; - previousIndentType = ''; - } else { - indent = matches[0].length; + const handlePromiseOnce = onetime(handlePromise); - if (matches[1]) { - indentType = INDENT_TYPE_SPACE; - } else { - indentType = INDENT_TYPE_TAB; - } + crossSpawn._enoent.hookChildProcess(spawned, parsed.parsed); - // Ignore single space unless it's the only indent detected to prevent common false positives - if (ignoreSingleSpaces && indentType === INDENT_TYPE_SPACE && indent === 1) { - continue; - } + handleInput(spawned, parsed.options.input); - if (indentType !== previousIndentType) { - previousSize = 0; - } + spawned.all = makeAllStream(spawned, parsed.options); - previousIndentType = indentType; + return mergePromise(spawned, handlePromiseOnce); +}; - weight = 0; +module.exports = execa; - const indentDifference = indent - previousSize; - previousSize = indent; +module.exports.sync = (file, args, options) => { + const parsed = handleArguments(file, args, options); + const command = joinCommand(file, args); - // Previous line have same indent? - if (indentDifference === 0) { - weight++; - // We use the key from previous loop - } else { - const absoluteIndentDifference = indentDifference > 0 ? indentDifference : -indentDifference; - key = encodeIndentsKey(indentType, absoluteIndentDifference); - } + validateInputSync(parsed.options); - // Update the stats - entry = indents.get(key); + let result; + try { + result = childProcess.spawnSync(parsed.file, parsed.args, parsed.options); + } catch (error) { + throw makeError({ + error, + stdout: '', + stderr: '', + all: '', + command, + parsed, + timedOut: false, + isCanceled: false, + killed: false + }); + } - if (entry === undefined) { - entry = [1, 0]; // Init - } else { - entry = [++entry[0], entry[1] + weight]; - } + const stdout = handleOutput(parsed.options, result.stdout, result.error); + const stderr = handleOutput(parsed.options, result.stderr, result.error); - indents.set(key, entry); + if (result.error || result.status !== 0 || result.signal !== null) { + const error = makeError({ + stdout, + stderr, + error: result.error, + signal: result.signal, + exitCode: result.status, + command, + parsed, + timedOut: result.error && result.error.code === 'ETIMEDOUT', + isCanceled: false, + killed: result.signal !== null + }); + + if (!parsed.options.reject) { + return error; } + + throw error; } - return indents; -} + return { + command, + exitCode: 0, + stdout, + stderr, + failed: false, + timedOut: false, + isCanceled: false, + killed: false + }; +}; -// Encode the indent type and amount as a string (e.g. 's4') for use as a compound key in the indents Map. -function encodeIndentsKey(indentType, indentAmount) { - const typeCharacter = indentType === INDENT_TYPE_SPACE ? 's' : 't'; - return typeCharacter + String(indentAmount); -} +module.exports.command = (command, options) => { + const [file, ...args] = parseCommand(command); + return execa(file, args, options); +}; -// Extract the indent type and amount from a key of the indents Map. -function decodeIndentsKey(indentsKey) { - const keyHasTypeSpace = indentsKey[0] === 's'; - const type = keyHasTypeSpace ? INDENT_TYPE_SPACE : INDENT_TYPE_TAB; +module.exports.commandSync = (command, options) => { + const [file, ...args] = parseCommand(command); + return execa.sync(file, args, options); +}; - const amount = Number(indentsKey.slice(1)); +module.exports.node = (scriptPath, args, options = {}) => { + if (args && !Array.isArray(args) && typeof args === 'object') { + options = args; + args = []; + } - return {type, amount}; -} + const stdio = normalizeStdio.node(options); -// Return the key (e.g. 's4') from the indents Map that represents the most common indent, -// or return undefined if there are no indents. -function getMostUsedKey(indents) { - let result; - let maxUsed = 0; - let maxWeight = 0; + const {nodePath = process.execPath, nodeOptions = process.execArgv} = options; - for (const [key, [usedCount, weight]] of indents) { - if (usedCount > maxUsed || (usedCount === maxUsed && weight > maxWeight)) { - maxUsed = usedCount; - maxWeight = weight; - result = key; + return execa( + nodePath, + [ + ...nodeOptions, + scriptPath, + ...(Array.isArray(args) ? args : []) + ], + { + ...options, + stdin: undefined, + stdout: undefined, + stderr: undefined, + stdio, + shell: false } - } + ); +}; - return result; -} -function makeIndentString(type, amount) { - const indentCharacter = type === INDENT_TYPE_SPACE ? ' ' : '\t'; - return indentCharacter.repeat(amount); -} - -module.exports = string => { - if (typeof string !== 'string') { - throw new TypeError('Expected a string'); - } +/***/ }), - // Identify indents while skipping single space indents to avoid common edge cases (e.g. code comments) - // If no indents are identified, run again and include all indents for comprehensive detection - let indents = makeIndentsMap(string, true); - if (indents.size === 0) { - indents = makeIndentsMap(string, false); - } +/***/ "../../node_modules/execa/lib/command.js": +/***/ (function(module, exports, __webpack_require__) { - const keyOfMostUsedIndent = getMostUsedKey(indents); +"use strict"; - let type; - let amount = 0; - let indent = ''; +const SPACES_REGEXP = / +/g; - if (keyOfMostUsedIndent !== undefined) { - ({type, amount} = decodeIndentsKey(keyOfMostUsedIndent)); - indent = makeIndentString(type, amount); +const joinCommand = (file, args = []) => { + if (!Array.isArray(args)) { + return file; } - return { - amount, - type, - indent - }; + return [file, ...args].join(' '); }; - -/***/ }), - -/***/ "../../node_modules/detect-newline/index.js": -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - - -const detectNewline = string => { - if (typeof string !== 'string') { - throw new TypeError('Expected a string'); +// Allow spaces to be escaped by a backslash if not meant as a delimiter +const handleEscaping = (tokens, token, index) => { + if (index === 0) { + return [token]; } - const newlines = string.match(/(?:\r?\n)/g) || []; + const previousToken = tokens[tokens.length - 1]; - if (newlines.length === 0) { - return; + if (previousToken.endsWith('\\')) { + return [...tokens.slice(0, -1), `${previousToken.slice(0, -1)} ${token}`]; } - const crlf = newlines.filter(newline => newline === '\r\n').length; - const lf = newlines.length - crlf; + return [...tokens, token]; +}; - return crlf > lf ? '\r\n' : '\n'; +// Handle `execa.command()` +const parseCommand = command => { + return command + .trim() + .split(SPACES_REGEXP) + .reduce(handleEscaping, []); }; -module.exports = detectNewline; -module.exports.graceful = string => (typeof string === 'string' && detectNewline(string)) || '\n'; +module.exports = { + joinCommand, + parseCommand +}; /***/ }), -/***/ "../../node_modules/dir-glob/index.js": +/***/ "../../node_modules/execa/lib/error.js": /***/ (function(module, exports, __webpack_require__) { "use strict"; -const path = __webpack_require__("path"); -const pathType = __webpack_require__("../../node_modules/path-type/index.js"); - -const getExtensions = extensions => extensions.length > 1 ? `{${extensions.join(',')}}` : extensions[0]; - -const getPath = (filepath, cwd) => { - const pth = filepath[0] === '!' ? filepath.slice(1) : filepath; - return path.isAbsolute(pth) ? pth : path.join(cwd, pth); -}; - -const addExtensions = (file, extensions) => { - if (path.extname(file)) { - return `**/${file}`; - } - - return `**/${file}.${getExtensions(extensions)}`; -}; +const {signalsByName} = __webpack_require__("../../node_modules/human-signals/build/src/main.js"); -const getGlob = (directory, options) => { - if (options.files && !Array.isArray(options.files)) { - throw new TypeError(`Expected \`files\` to be of type \`Array\` but received type \`${typeof options.files}\``); +const getErrorPrefix = ({timedOut, timeout, errorCode, signal, signalDescription, exitCode, isCanceled}) => { + if (timedOut) { + return `timed out after ${timeout} milliseconds`; } - if (options.extensions && !Array.isArray(options.extensions)) { - throw new TypeError(`Expected \`extensions\` to be of type \`Array\` but received type \`${typeof options.extensions}\``); + if (isCanceled) { + return 'was canceled'; } - if (options.files && options.extensions) { - return options.files.map(x => path.posix.join(directory, addExtensions(x, options.extensions))); + if (errorCode !== undefined) { + return `failed with ${errorCode}`; } - if (options.files) { - return options.files.map(x => path.posix.join(directory, `**/${x}`)); + if (signal !== undefined) { + return `was killed with ${signal} (${signalDescription})`; } - if (options.extensions) { - return [path.posix.join(directory, `**/*.${getExtensions(options.extensions)}`)]; + if (exitCode !== undefined) { + return `failed with exit code ${exitCode}`; } - return [path.posix.join(directory, '**')]; + return 'failed'; }; -module.exports = async (input, options) => { - options = { - cwd: process.cwd(), - ...options - }; +const makeError = ({ + stdout, + stderr, + all, + error, + signal, + exitCode, + command, + timedOut, + isCanceled, + killed, + parsed: {options: {timeout}} +}) => { + // `signal` and `exitCode` emitted on `spawned.on('exit')` event can be `null`. + // We normalize them to `undefined` + exitCode = exitCode === null ? undefined : exitCode; + signal = signal === null ? undefined : signal; + const signalDescription = signal === undefined ? undefined : signalsByName[signal].description; - if (typeof options.cwd !== 'string') { - throw new TypeError(`Expected \`cwd\` to be of type \`string\` but received type \`${typeof options.cwd}\``); - } + const errorCode = error && error.code; - const globs = await Promise.all([].concat(input).map(async x => { - const isDirectory = await pathType.isDirectory(getPath(x, options.cwd)); - return isDirectory ? getGlob(x, options) : x; - })); + const prefix = getErrorPrefix({timedOut, timeout, errorCode, signal, signalDescription, exitCode, isCanceled}); + const execaMessage = `Command ${prefix}: ${command}`; + const isError = Object.prototype.toString.call(error) === '[object Error]'; + const shortMessage = isError ? `${execaMessage}\n${error.message}` : execaMessage; + const message = [shortMessage, stderr, stdout].filter(Boolean).join('\n'); - return [].concat.apply([], globs); // eslint-disable-line prefer-spread -}; + if (isError) { + error.originalMessage = error.message; + error.message = message; + } else { + error = new Error(message); + } -module.exports.sync = (input, options) => { - options = { - cwd: process.cwd(), - ...options - }; + error.shortMessage = shortMessage; + error.command = command; + error.exitCode = exitCode; + error.signal = signal; + error.signalDescription = signalDescription; + error.stdout = stdout; + error.stderr = stderr; - if (typeof options.cwd !== 'string') { - throw new TypeError(`Expected \`cwd\` to be of type \`string\` but received type \`${typeof options.cwd}\``); + if (all !== undefined) { + error.all = all; } - const globs = [].concat(input).map(x => pathType.isDirectorySync(getPath(x, options.cwd)) ? getGlob(x, options) : x); + if ('bufferedData' in error) { + delete error.bufferedData; + } - return [].concat.apply([], globs); // eslint-disable-line prefer-spread + error.failed = true; + error.timedOut = Boolean(timedOut); + error.isCanceled = isCanceled; + error.killed = killed && !timedOut; + + return error; }; +module.exports = makeError; + /***/ }), -/***/ "../../node_modules/duplexer/index.js": +/***/ "../../node_modules/execa/lib/kill.js": /***/ (function(module, exports, __webpack_require__) { -var Stream = __webpack_require__("stream") -var writeMethods = ["write", "end", "destroy"] -var readMethods = ["resume", "pause"] -var readEvents = ["data", "close"] -var slice = Array.prototype.slice +"use strict"; -module.exports = duplex +const os = __webpack_require__("os"); +const onExit = __webpack_require__("../../node_modules/signal-exit/index.js"); -function forEach (arr, fn) { - if (arr.forEach) { - return arr.forEach(fn) - } +const DEFAULT_FORCE_KILL_TIMEOUT = 1000 * 5; - for (var i = 0; i < arr.length; i++) { - fn(arr[i], i) - } -} +// Monkey-patches `childProcess.kill()` to add `forceKillAfterTimeout` behavior +const spawnedKill = (kill, signal = 'SIGTERM', options = {}) => { + const killResult = kill(signal); + setKillTimeout(kill, signal, options, killResult); + return killResult; +}; -function duplex(writer, reader) { - var stream = new Stream() - var ended = false +const setKillTimeout = (kill, signal, options, killResult) => { + if (!shouldForceKill(signal, options, killResult)) { + return; + } - forEach(writeMethods, proxyWriter) + const timeout = getForceKillAfterTimeout(options); + const t = setTimeout(() => { + kill('SIGKILL'); + }, timeout); - forEach(readMethods, proxyReader) + // Guarded because there's no `.unref()` when `execa` is used in the renderer + // process in Electron. This cannot be tested since we don't run tests in + // Electron. + // istanbul ignore else + if (t.unref) { + t.unref(); + } +}; - forEach(readEvents, proxyStream) +const shouldForceKill = (signal, {forceKillAfterTimeout}, killResult) => { + return isSigterm(signal) && forceKillAfterTimeout !== false && killResult; +}; - reader.on("end", handleEnd) +const isSigterm = signal => { + return signal === os.constants.signals.SIGTERM || + (typeof signal === 'string' && signal.toUpperCase() === 'SIGTERM'); +}; - writer.on("drain", function() { - stream.emit("drain") - }) +const getForceKillAfterTimeout = ({forceKillAfterTimeout = true}) => { + if (forceKillAfterTimeout === true) { + return DEFAULT_FORCE_KILL_TIMEOUT; + } - writer.on("error", reemit) - reader.on("error", reemit) - - stream.writable = writer.writable - stream.readable = reader.readable - - return stream - - function proxyWriter(methodName) { - stream[methodName] = method - - function method() { - return writer[methodName].apply(writer, arguments) - } - } + if (!Number.isFinite(forceKillAfterTimeout) || forceKillAfterTimeout < 0) { + throw new TypeError(`Expected the \`forceKillAfterTimeout\` option to be a non-negative integer, got \`${forceKillAfterTimeout}\` (${typeof forceKillAfterTimeout})`); + } - function proxyReader(methodName) { - stream[methodName] = method + return forceKillAfterTimeout; +}; - function method() { - stream.emit(methodName) - var func = reader[methodName] - if (func) { - return func.apply(reader, arguments) - } - reader.emit(methodName) - } - } +// `childProcess.cancel()` +const spawnedCancel = (spawned, context) => { + const killResult = spawned.kill(); - function proxyStream(methodName) { - reader.on(methodName, reemit) + if (killResult) { + context.isCanceled = true; + } +}; - function reemit() { - var args = slice.call(arguments) - args.unshift(methodName) - stream.emit.apply(stream, args) - } - } +const timeoutKill = (spawned, signal, reject) => { + spawned.kill(signal); + reject(Object.assign(new Error('Timed out'), {timedOut: true, signal})); +}; - function handleEnd() { - if (ended) { - return - } - ended = true - var args = slice.call(arguments) - args.unshift("end") - stream.emit.apply(stream, args) - } +// `timeout` option handling +const setupTimeout = (spawned, {timeout, killSignal = 'SIGTERM'}, spawnedPromise) => { + if (timeout === 0 || timeout === undefined) { + return spawnedPromise; + } - function reemit(err) { - stream.emit("error", err) - } -} + if (!Number.isFinite(timeout) || timeout < 0) { + throw new TypeError(`Expected the \`timeout\` option to be a non-negative integer, got \`${timeout}\` (${typeof timeout})`); + } + let timeoutId; + const timeoutPromise = new Promise((resolve, reject) => { + timeoutId = setTimeout(() => { + timeoutKill(spawned, killSignal, reject); + }, timeout); + }); -/***/ }), + const safeSpawnedPromise = spawnedPromise.finally(() => { + clearTimeout(timeoutId); + }); -/***/ "../../node_modules/end-of-stream/index.js": -/***/ (function(module, exports, __webpack_require__) { + return Promise.race([timeoutPromise, safeSpawnedPromise]); +}; -var once = __webpack_require__("../../node_modules/once/once.js"); +// `cleanup` option handling +const setExitHandler = async (spawned, {cleanup, detached}, timedPromise) => { + if (!cleanup || detached) { + return timedPromise; + } -var noop = function() {}; + const removeExitHandler = onExit(() => { + spawned.kill(); + }); -var isRequest = function(stream) { - return stream.setHeader && typeof stream.abort === 'function'; + return timedPromise.finally(() => { + removeExitHandler(); + }); }; -var isChildProcess = function(stream) { - return stream.stdio && Array.isArray(stream.stdio) && stream.stdio.length === 3 +module.exports = { + spawnedKill, + spawnedCancel, + setupTimeout, + setExitHandler }; -var eos = function(stream, opts, callback) { - if (typeof opts === 'function') return eos(stream, null, opts); - if (!opts) opts = {}; - - callback = once(callback || noop); - - var ws = stream._writableState; - var rs = stream._readableState; - var readable = opts.readable || (opts.readable !== false && stream.readable); - var writable = opts.writable || (opts.writable !== false && stream.writable); - var cancelled = false; - var onlegacyfinish = function() { - if (!stream.writable) onfinish(); - }; +/***/ }), - var onfinish = function() { - writable = false; - if (!readable) callback.call(stream); - }; +/***/ "../../node_modules/execa/lib/promise.js": +/***/ (function(module, exports, __webpack_require__) { - var onend = function() { - readable = false; - if (!writable) callback.call(stream); - }; +"use strict"; - var onexit = function(exitCode) { - callback.call(stream, exitCode ? new Error('exited with error code: ' + exitCode) : null); - }; - var onerror = function(err) { - callback.call(stream, err); - }; +const nativePromisePrototype = (async () => {})().constructor.prototype; +const descriptors = ['then', 'catch', 'finally'].map(property => [ + property, + Reflect.getOwnPropertyDescriptor(nativePromisePrototype, property) +]); - var onclose = function() { - process.nextTick(onclosenexttick); - }; +// The return value is a mixin of `childProcess` and `Promise` +const mergePromise = (spawned, promise) => { + for (const [property, descriptor] of descriptors) { + // Starting the main `promise` is deferred to avoid consuming streams + const value = typeof promise === 'function' ? + (...args) => Reflect.apply(descriptor.value, promise(), args) : + descriptor.value.bind(promise); - var onclosenexttick = function() { - if (cancelled) return; - if (readable && !(rs && (rs.ended && !rs.destroyed))) return callback.call(stream, new Error('premature close')); - if (writable && !(ws && (ws.ended && !ws.destroyed))) return callback.call(stream, new Error('premature close')); - }; + Reflect.defineProperty(spawned, property, {...descriptor, value}); + } - var onrequest = function() { - stream.req.on('finish', onfinish); - }; + return spawned; +}; - if (isRequest(stream)) { - stream.on('complete', onfinish); - stream.on('abort', onclose); - if (stream.req) onrequest(); - else stream.on('request', onrequest); - } else if (writable && !ws) { // legacy streams - stream.on('end', onlegacyfinish); - stream.on('close', onlegacyfinish); - } +// Use promises instead of `child_process` events +const getSpawnedPromise = spawned => { + return new Promise((resolve, reject) => { + spawned.on('exit', (exitCode, signal) => { + resolve({exitCode, signal}); + }); - if (isChildProcess(stream)) stream.on('exit', onexit); + spawned.on('error', error => { + reject(error); + }); - stream.on('end', onend); - stream.on('finish', onfinish); - if (opts.error !== false) stream.on('error', onerror); - stream.on('close', onclose); + if (spawned.stdin) { + spawned.stdin.on('error', error => { + reject(error); + }); + } + }); +}; - return function() { - cancelled = true; - stream.removeListener('complete', onfinish); - stream.removeListener('abort', onclose); - stream.removeListener('request', onrequest); - if (stream.req) stream.req.removeListener('finish', onfinish); - stream.removeListener('end', onlegacyfinish); - stream.removeListener('close', onlegacyfinish); - stream.removeListener('finish', onfinish); - stream.removeListener('exit', onexit); - stream.removeListener('end', onend); - stream.removeListener('error', onerror); - stream.removeListener('close', onclose); - }; +module.exports = { + mergePromise, + getSpawnedPromise }; -module.exports = eos; /***/ }), -/***/ "../../node_modules/error-ex/index.js": +/***/ "../../node_modules/execa/lib/stdio.js": /***/ (function(module, exports, __webpack_require__) { "use strict"; +const aliases = ['stdin', 'stdout', 'stderr']; -var util = __webpack_require__("util"); -var isArrayish = __webpack_require__("../../node_modules/is-arrayish/index.js"); +const hasAlias = opts => aliases.some(alias => opts[alias] !== undefined); -var errorEx = function errorEx(name, properties) { - if (!name || name.constructor !== String) { - properties = name || {}; - name = Error.name; +const normalizeStdio = opts => { + if (!opts) { + return; } - var errorExError = function ErrorEXError(message) { - if (!this) { - return new ErrorEXError(message); - } + const {stdio} = opts; - message = message instanceof Error - ? message.message - : (message || this.message); + if (stdio === undefined) { + return aliases.map(alias => opts[alias]); + } - Error.call(this, message); - Error.captureStackTrace(this, errorExError); + if (hasAlias(opts)) { + throw new Error(`It's not possible to provide \`stdio\` in combination with one of ${aliases.map(alias => `\`${alias}\``).join(', ')}`); + } - this.name = name; + if (typeof stdio === 'string') { + return stdio; + } - Object.defineProperty(this, 'message', { - configurable: true, - enumerable: false, - get: function () { - var newMessage = message.split(/\r?\n/g); + if (!Array.isArray(stdio)) { + throw new TypeError(`Expected \`stdio\` to be of type \`string\` or \`Array\`, got \`${typeof stdio}\``); + } - for (var key in properties) { - if (!properties.hasOwnProperty(key)) { - continue; - } + const length = Math.max(stdio.length, aliases.length); + return Array.from({length}, (value, index) => stdio[index]); +}; - var modifier = properties[key]; +module.exports = normalizeStdio; - if ('message' in modifier) { - newMessage = modifier.message(this[key], newMessage) || newMessage; - if (!isArrayish(newMessage)) { - newMessage = [newMessage]; - } - } - } +// `ipc` is pushed unless it is already present +module.exports.node = opts => { + const stdio = normalizeStdio(opts); - return newMessage.join('\n'); - }, - set: function (v) { - message = v; - } - }); + if (stdio === 'ipc') { + return 'ipc'; + } - var stackDescriptor = Object.getOwnPropertyDescriptor(this, 'stack'); - var stackGetter = stackDescriptor.get; - var stackValue = stackDescriptor.value; - delete stackDescriptor.value; - delete stackDescriptor.writable; + if (stdio === undefined || typeof stdio === 'string') { + return [stdio, stdio, stdio, 'ipc']; + } - stackDescriptor.get = function () { - var stack = (stackGetter) - ? stackGetter.call(this).split(/\r?\n+/g) - : stackValue.split(/\r?\n+/g); + if (stdio.includes('ipc')) { + return stdio; + } - // starting in Node 7, the stack builder caches the message. - // just replace it. - stack[0] = this.name + ': ' + this.message; + return [...stdio, 'ipc']; +}; - var lineCount = 1; - for (var key in properties) { - if (!properties.hasOwnProperty(key)) { - continue; - } - var modifier = properties[key]; +/***/ }), - if ('line' in modifier) { - var line = modifier.line(this[key]); - if (line) { - stack.splice(lineCount++, 0, ' ' + line); - } - } +/***/ "../../node_modules/execa/lib/stream.js": +/***/ (function(module, exports, __webpack_require__) { - if ('stack' in modifier) { - modifier.stack(this[key], stack); - } - } +"use strict"; - return stack.join('\n'); - }; +const isStream = __webpack_require__("../../node_modules/is-stream/index.js"); +const getStream = __webpack_require__("../../node_modules/get-stream/index.js"); +const mergeStream = __webpack_require__("../../node_modules/merge-stream/index.js"); - Object.defineProperty(this, 'stack', stackDescriptor); - }; +// `input` option +const handleInput = (spawned, input) => { + // Checking for stdin is workaround for https://github.com/nodejs/node/issues/26852 + // TODO: Remove `|| spawned.stdin === undefined` once we drop support for Node.js <=12.2.0 + if (input === undefined || spawned.stdin === undefined) { + return; + } - if (Object.setPrototypeOf) { - Object.setPrototypeOf(errorExError.prototype, Error.prototype); - Object.setPrototypeOf(errorExError, Error); + if (isStream(input)) { + input.pipe(spawned.stdin); } else { - util.inherits(errorExError, Error); + spawned.stdin.end(input); } - - return errorExError; }; -errorEx.append = function (str, def) { - return { - message: function (v, message) { - v = v || def; - - if (v) { - message[0] += ' ' + str.replace('%s', v.toString()); - } +// `all` interleaves `stdout` and `stderr` +const makeAllStream = (spawned, {all}) => { + if (!all || (!spawned.stdout && !spawned.stderr)) { + return; + } - return message; - } - }; -}; + const mixed = mergeStream(); -errorEx.line = function (str, def) { - return { - line: function (v) { - v = v || def; + if (spawned.stdout) { + mixed.add(spawned.stdout); + } - if (v) { - return str.replace('%s', v.toString()); - } + if (spawned.stderr) { + mixed.add(spawned.stderr); + } - return null; - } - }; + return mixed; }; -module.exports = errorEx; +// On failure, `result.stdout|stderr|all` should contain the currently buffered stream +const getBufferedData = async (stream, streamPromise) => { + if (!stream) { + return; + } + stream.destroy(); -/***/ }), + try { + return await streamPromise; + } catch (error) { + return error.bufferedData; + } +}; -/***/ "../../node_modules/escape-string-regexp/index.js": -/***/ (function(module, exports, __webpack_require__) { +const getStreamPromise = (stream, {encoding, buffer, maxBuffer}) => { + if (!stream || !buffer) { + return; + } -"use strict"; + if (encoding) { + return getStream(stream, {encoding, maxBuffer}); + } + return getStream.buffer(stream, {maxBuffer}); +}; -var matchOperatorsRe = /[|\\{}()[\]^$+*?.]/g; +// Retrieve result of child process: exit code, signal, error, streams (stdout/stderr/all) +const getSpawnedResult = async ({stdout, stderr, all}, {encoding, buffer, maxBuffer}, processDone) => { + const stdoutPromise = getStreamPromise(stdout, {encoding, buffer, maxBuffer}); + const stderrPromise = getStreamPromise(stderr, {encoding, buffer, maxBuffer}); + const allPromise = getStreamPromise(all, {encoding, buffer, maxBuffer: maxBuffer * 2}); -module.exports = function (str) { - if (typeof str !== 'string') { - throw new TypeError('Expected a string'); + try { + return await Promise.all([processDone, stdoutPromise, stderrPromise, allPromise]); + } catch (error) { + return Promise.all([ + {error, signal: error.signal, timedOut: error.timedOut}, + getBufferedData(stdout, stdoutPromise), + getBufferedData(stderr, stderrPromise), + getBufferedData(all, allPromise) + ]); + } +}; + +const validateInputSync = ({input}) => { + if (isStream(input)) { + throw new TypeError('The `input` option cannot be a stream in sync mode'); } +}; - return str.replace(matchOperatorsRe, '\\$&'); +module.exports = { + handleInput, + makeAllStream, + getSpawnedResult, + validateInputSync }; + /***/ }), -/***/ "../../node_modules/execa/index.js": +/***/ "../../node_modules/fast-glob/node_modules/micromatch/index.js": /***/ (function(module, exports, __webpack_require__) { "use strict"; -const path = __webpack_require__("path"); -const childProcess = __webpack_require__("child_process"); -const crossSpawn = __webpack_require__("../../node_modules/cross-spawn/index.js"); -const stripFinalNewline = __webpack_require__("../../node_modules/strip-final-newline/index.js"); -const npmRunPath = __webpack_require__("../../node_modules/npm-run-path/index.js"); -const onetime = __webpack_require__("../../node_modules/onetime/index.js"); -const makeError = __webpack_require__("../../node_modules/execa/lib/error.js"); -const normalizeStdio = __webpack_require__("../../node_modules/execa/lib/stdio.js"); -const {spawnedKill, spawnedCancel, setupTimeout, setExitHandler} = __webpack_require__("../../node_modules/execa/lib/kill.js"); -const {handleInput, getSpawnedResult, makeAllStream, validateInputSync} = __webpack_require__("../../node_modules/execa/lib/stream.js"); -const {mergePromise, getSpawnedPromise} = __webpack_require__("../../node_modules/execa/lib/promise.js"); -const {joinCommand, parseCommand} = __webpack_require__("../../node_modules/execa/lib/command.js"); -const DEFAULT_MAX_BUFFER = 1000 * 1000 * 100; +const util = __webpack_require__("util"); +const braces = __webpack_require__("../../node_modules/braces/index.js"); +const picomatch = __webpack_require__("../../node_modules/picomatch/index.js"); +const utils = __webpack_require__("../../node_modules/picomatch/lib/utils.js"); +const isEmptyString = val => val === '' || val === './'; -const getEnv = ({env: envOption, extendEnv, preferLocal, localDir, execPath}) => { - const env = extendEnv ? {...process.env, ...envOption} : envOption; +/** + * Returns an array of strings that match one or more glob patterns. + * + * ```js + * const mm = require('micromatch'); + * // mm(list, patterns[, options]); + * + * console.log(mm(['a.js', 'a.txt'], ['*.js'])); + * //=> [ 'a.js' ] + * ``` + * @param {String|Array} `list` List of strings to match. + * @param {String|Array} `patterns` One or more glob patterns to use for matching. + * @param {Object} `options` See available [options](#options) + * @return {Array} Returns an array of matches + * @summary false + * @api public + */ - if (preferLocal) { - return npmRunPath.env({env, cwd: localDir, execPath}); - } +const micromatch = (list, patterns, options) => { + patterns = [].concat(patterns); + list = [].concat(list); - return env; -}; + let omit = new Set(); + let keep = new Set(); + let items = new Set(); + let negatives = 0; -const handleArguments = (file, args, options = {}) => { - const parsed = crossSpawn._parse(file, args, options); - file = parsed.command; - args = parsed.args; - options = parsed.options; + let onResult = state => { + items.add(state.output); + if (options && options.onResult) { + options.onResult(state); + } + }; - options = { - maxBuffer: DEFAULT_MAX_BUFFER, - buffer: true, - stripFinalNewline: true, - extendEnv: true, - preferLocal: false, - localDir: options.cwd || process.cwd(), - execPath: process.execPath, - encoding: 'utf8', - reject: true, - cleanup: true, - all: false, - windowsHide: true, - ...options - }; + for (let i = 0; i < patterns.length; i++) { + let isMatch = picomatch(String(patterns[i]), { ...options, onResult }, true); + let negated = isMatch.state.negated || isMatch.state.negatedExtglob; + if (negated) negatives++; - options.env = getEnv(options); + for (let item of list) { + let matched = isMatch(item, true); - options.stdio = normalizeStdio(options); + let match = negated ? !matched.isMatch : matched.isMatch; + if (!match) continue; - if (process.platform === 'win32' && path.basename(file, '.exe') === 'cmd') { - // #116 - args.unshift('/q'); - } + if (negated) { + omit.add(matched.output); + } else { + omit.delete(matched.output); + keep.add(matched.output); + } + } + } - return {file, args, options, parsed}; -}; + let result = negatives === patterns.length ? [...items] : [...keep]; + let matches = result.filter(item => !omit.has(item)); -const handleOutput = (options, value, error) => { - if (typeof value !== 'string' && !Buffer.isBuffer(value)) { - // When `execa.sync()` errors, we normalize it to '' to mimic `execa()` - return error === undefined ? undefined : ''; - } + if (options && matches.length === 0) { + if (options.failglob === true) { + throw new Error(`No matches found for "${patterns.join(', ')}"`); + } - if (options.stripFinalNewline) { - return stripFinalNewline(value); - } + if (options.nonull === true || options.nullglob === true) { + return options.unescape ? patterns.map(p => p.replace(/\\/g, '')) : patterns; + } + } - return value; + return matches; }; -const execa = (file, args, options) => { - const parsed = handleArguments(file, args, options); - const command = joinCommand(file, args); - - let spawned; - try { - spawned = childProcess.spawn(parsed.file, parsed.args, parsed.options); - } catch (error) { - // Ensure the returned error is always both a promise and a child process - const dummySpawned = new childProcess.ChildProcess(); - const errorPromise = Promise.reject(makeError({ - error, - stdout: '', - stderr: '', - all: '', - command, - parsed, - timedOut: false, - isCanceled: false, - killed: false - })); - return mergePromise(dummySpawned, errorPromise); - } - - const spawnedPromise = getSpawnedPromise(spawned); - const timedPromise = setupTimeout(spawned, parsed.options, spawnedPromise); - const processDone = setExitHandler(spawned, parsed.options, timedPromise); +/** + * Backwards compatibility + */ - const context = {isCanceled: false}; +micromatch.match = micromatch; - spawned.kill = spawnedKill.bind(null, spawned.kill.bind(spawned)); - spawned.cancel = spawnedCancel.bind(null, spawned, context); +/** + * Returns a matcher function from the given glob `pattern` and `options`. + * The returned function takes a string to match as its only argument and returns + * true if the string is a match. + * + * ```js + * const mm = require('micromatch'); + * // mm.matcher(pattern[, options]); + * + * const isMatch = mm.matcher('*.!(*a)'); + * console.log(isMatch('a.a')); //=> false + * console.log(isMatch('a.b')); //=> true + * ``` + * @param {String} `pattern` Glob pattern + * @param {Object} `options` + * @return {Function} Returns a matcher function. + * @api public + */ - const handlePromise = async () => { - const [{error, exitCode, signal, timedOut}, stdoutResult, stderrResult, allResult] = await getSpawnedResult(spawned, parsed.options, processDone); - const stdout = handleOutput(parsed.options, stdoutResult); - const stderr = handleOutput(parsed.options, stderrResult); - const all = handleOutput(parsed.options, allResult); +micromatch.matcher = (pattern, options) => picomatch(pattern, options); - if (error || exitCode !== 0 || signal !== null) { - const returnedError = makeError({ - error, - exitCode, - signal, - stdout, - stderr, - all, - command, - parsed, - timedOut, - isCanceled: context.isCanceled, - killed: spawned.killed - }); +/** + * Returns true if **any** of the given glob `patterns` match the specified `string`. + * + * ```js + * const mm = require('micromatch'); + * // mm.isMatch(string, patterns[, options]); + * + * console.log(mm.isMatch('a.a', ['b.*', '*.a'])); //=> true + * console.log(mm.isMatch('a.a', 'b.*')); //=> false + * ``` + * @param {String} `str` The string to test. + * @param {String|Array} `patterns` One or more glob patterns to use for matching. + * @param {Object} `[options]` See available [options](#options). + * @return {Boolean} Returns true if any patterns match `str` + * @api public + */ - if (!parsed.options.reject) { - return returnedError; - } +micromatch.isMatch = (str, patterns, options) => picomatch(patterns, options)(str); - throw returnedError; - } +/** + * Backwards compatibility + */ - return { - command, - exitCode: 0, - stdout, - stderr, - all, - failed: false, - timedOut: false, - isCanceled: false, - killed: false - }; - }; +micromatch.any = micromatch.isMatch; - const handlePromiseOnce = onetime(handlePromise); +/** + * Returns a list of strings that _**do not match any**_ of the given `patterns`. + * + * ```js + * const mm = require('micromatch'); + * // mm.not(list, patterns[, options]); + * + * console.log(mm.not(['a.a', 'b.b', 'c.c'], '*.a')); + * //=> ['b.b', 'c.c'] + * ``` + * @param {Array} `list` Array of strings to match. + * @param {String|Array} `patterns` One or more glob pattern to use for matching. + * @param {Object} `options` See available [options](#options) for changing how matches are performed + * @return {Array} Returns an array of strings that **do not match** the given patterns. + * @api public + */ - crossSpawn._enoent.hookChildProcess(spawned, parsed.parsed); +micromatch.not = (list, patterns, options = {}) => { + patterns = [].concat(patterns).map(String); + let result = new Set(); + let items = []; - handleInput(spawned, parsed.options.input); + let onResult = state => { + if (options.onResult) options.onResult(state); + items.push(state.output); + }; - spawned.all = makeAllStream(spawned, parsed.options); + let matches = micromatch(list, patterns, { ...options, onResult }); - return mergePromise(spawned, handlePromiseOnce); + for (let item of items) { + if (!matches.includes(item)) { + result.add(item); + } + } + return [...result]; }; -module.exports = execa; +/** + * Returns true if the given `string` contains the given pattern. Similar + * to [.isMatch](#isMatch) but the pattern can match any part of the string. + * + * ```js + * var mm = require('micromatch'); + * // mm.contains(string, pattern[, options]); + * + * console.log(mm.contains('aa/bb/cc', '*b')); + * //=> true + * console.log(mm.contains('aa/bb/cc', '*d')); + * //=> false + * ``` + * @param {String} `str` The string to match. + * @param {String|Array} `patterns` Glob pattern to use for matching. + * @param {Object} `options` See available [options](#options) for changing how matches are performed + * @return {Boolean} Returns true if any of the patterns matches any part of `str`. + * @api public + */ -module.exports.sync = (file, args, options) => { - const parsed = handleArguments(file, args, options); - const command = joinCommand(file, args); +micromatch.contains = (str, pattern, options) => { + if (typeof str !== 'string') { + throw new TypeError(`Expected a string: "${util.inspect(str)}"`); + } - validateInputSync(parsed.options); + if (Array.isArray(pattern)) { + return pattern.some(p => micromatch.contains(str, p, options)); + } - let result; - try { - result = childProcess.spawnSync(parsed.file, parsed.args, parsed.options); - } catch (error) { - throw makeError({ - error, - stdout: '', - stderr: '', - all: '', - command, - parsed, - timedOut: false, - isCanceled: false, - killed: false - }); - } + if (typeof pattern === 'string') { + if (isEmptyString(str) || isEmptyString(pattern)) { + return false; + } - const stdout = handleOutput(parsed.options, result.stdout, result.error); - const stderr = handleOutput(parsed.options, result.stderr, result.error); + if (str.includes(pattern) || (str.startsWith('./') && str.slice(2).includes(pattern))) { + return true; + } + } - if (result.error || result.status !== 0 || result.signal !== null) { - const error = makeError({ - stdout, - stderr, - error: result.error, - signal: result.signal, - exitCode: result.status, - command, - parsed, - timedOut: result.error && result.error.code === 'ETIMEDOUT', - isCanceled: false, - killed: result.signal !== null - }); - - if (!parsed.options.reject) { - return error; - } - - throw error; - } - - return { - command, - exitCode: 0, - stdout, - stderr, - failed: false, - timedOut: false, - isCanceled: false, - killed: false - }; + return micromatch.isMatch(str, pattern, { ...options, contains: true }); }; -module.exports.command = (command, options) => { - const [file, ...args] = parseCommand(command); - return execa(file, args, options); -}; +/** + * Filter the keys of the given object with the given `glob` pattern + * and `options`. Does not attempt to match nested keys. If you need this feature, + * use [glob-object][] instead. + * + * ```js + * const mm = require('micromatch'); + * // mm.matchKeys(object, patterns[, options]); + * + * const obj = { aa: 'a', ab: 'b', ac: 'c' }; + * console.log(mm.matchKeys(obj, '*b')); + * //=> { ab: 'b' } + * ``` + * @param {Object} `object` The object with keys to filter. + * @param {String|Array} `patterns` One or more glob patterns to use for matching. + * @param {Object} `options` See available [options](#options) for changing how matches are performed + * @return {Object} Returns an object with only keys that match the given patterns. + * @api public + */ -module.exports.commandSync = (command, options) => { - const [file, ...args] = parseCommand(command); - return execa.sync(file, args, options); +micromatch.matchKeys = (obj, patterns, options) => { + if (!utils.isObject(obj)) { + throw new TypeError('Expected the first argument to be an object'); + } + let keys = micromatch(Object.keys(obj), patterns, options); + let res = {}; + for (let key of keys) res[key] = obj[key]; + return res; }; -module.exports.node = (scriptPath, args, options = {}) => { - if (args && !Array.isArray(args) && typeof args === 'object') { - options = args; - args = []; - } - - const stdio = normalizeStdio.node(options); +/** + * Returns true if some of the strings in the given `list` match any of the given glob `patterns`. + * + * ```js + * const mm = require('micromatch'); + * // mm.some(list, patterns[, options]); + * + * console.log(mm.some(['foo.js', 'bar.js'], ['*.js', '!foo.js'])); + * // true + * console.log(mm.some(['foo.js'], ['*.js', '!foo.js'])); + * // false + * ``` + * @param {String|Array} `list` The string or array of strings to test. Returns as soon as the first match is found. + * @param {String|Array} `patterns` One or more glob patterns to use for matching. + * @param {Object} `options` See available [options](#options) for changing how matches are performed + * @return {Boolean} Returns true if any `patterns` matches any of the strings in `list` + * @api public + */ - const {nodePath = process.execPath, nodeOptions = process.execArgv} = options; +micromatch.some = (list, patterns, options) => { + let items = [].concat(list); - return execa( - nodePath, - [ - ...nodeOptions, - scriptPath, - ...(Array.isArray(args) ? args : []) - ], - { - ...options, - stdin: undefined, - stdout: undefined, - stderr: undefined, - stdio, - shell: false - } - ); + for (let pattern of [].concat(patterns)) { + let isMatch = picomatch(String(pattern), options); + if (items.some(item => isMatch(item))) { + return true; + } + } + return false; }; +/** + * Returns true if every string in the given `list` matches + * any of the given glob `patterns`. + * + * ```js + * const mm = require('micromatch'); + * // mm.every(list, patterns[, options]); + * + * console.log(mm.every('foo.js', ['foo.js'])); + * // true + * console.log(mm.every(['foo.js', 'bar.js'], ['*.js'])); + * // true + * console.log(mm.every(['foo.js', 'bar.js'], ['*.js', '!foo.js'])); + * // false + * console.log(mm.every(['foo.js'], ['*.js', '!foo.js'])); + * // false + * ``` + * @param {String|Array} `list` The string or array of strings to test. + * @param {String|Array} `patterns` One or more glob patterns to use for matching. + * @param {Object} `options` See available [options](#options) for changing how matches are performed + * @return {Boolean} Returns true if all `patterns` matches all of the strings in `list` + * @api public + */ -/***/ }), - -/***/ "../../node_modules/execa/lib/command.js": -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - -const SPACES_REGEXP = / +/g; - -const joinCommand = (file, args = []) => { - if (!Array.isArray(args)) { - return file; - } +micromatch.every = (list, patterns, options) => { + let items = [].concat(list); - return [file, ...args].join(' '); + for (let pattern of [].concat(patterns)) { + let isMatch = picomatch(String(pattern), options); + if (!items.every(item => isMatch(item))) { + return false; + } + } + return true; }; -// Allow spaces to be escaped by a backslash if not meant as a delimiter -const handleEscaping = (tokens, token, index) => { - if (index === 0) { - return [token]; - } - - const previousToken = tokens[tokens.length - 1]; - - if (previousToken.endsWith('\\')) { - return [...tokens.slice(0, -1), `${previousToken.slice(0, -1)} ${token}`]; - } +/** + * Returns true if **all** of the given `patterns` match + * the specified string. + * + * ```js + * const mm = require('micromatch'); + * // mm.all(string, patterns[, options]); + * + * console.log(mm.all('foo.js', ['foo.js'])); + * // true + * + * console.log(mm.all('foo.js', ['*.js', '!foo.js'])); + * // false + * + * console.log(mm.all('foo.js', ['*.js', 'foo.js'])); + * // true + * + * console.log(mm.all('foo.js', ['*.js', 'f*', '*o*', '*o.js'])); + * // true + * ``` + * @param {String|Array} `str` The string to test. + * @param {String|Array} `patterns` One or more glob patterns to use for matching. + * @param {Object} `options` See available [options](#options) for changing how matches are performed + * @return {Boolean} Returns true if any patterns match `str` + * @api public + */ - return [...tokens, token]; -}; +micromatch.all = (str, patterns, options) => { + if (typeof str !== 'string') { + throw new TypeError(`Expected a string: "${util.inspect(str)}"`); + } -// Handle `execa.command()` -const parseCommand = command => { - return command - .trim() - .split(SPACES_REGEXP) - .reduce(handleEscaping, []); + return [].concat(patterns).every(p => picomatch(p, options)(str)); }; -module.exports = { - joinCommand, - parseCommand -}; +/** + * Returns an array of matches captured by `pattern` in `string, or `null` if the pattern did not match. + * + * ```js + * const mm = require('micromatch'); + * // mm.capture(pattern, string[, options]); + * + * console.log(mm.capture('test/*.js', 'test/foo.js')); + * //=> ['foo'] + * console.log(mm.capture('test/*.js', 'foo/bar.css')); + * //=> null + * ``` + * @param {String} `glob` Glob pattern to use for matching. + * @param {String} `input` String to match + * @param {Object} `options` See available [options](#options) for changing how matches are performed + * @return {Array|null} Returns an array of captures if the input matches the glob pattern, otherwise `null`. + * @api public + */ +micromatch.capture = (glob, input, options) => { + let posix = utils.isWindows(options); + let regex = picomatch.makeRe(String(glob), { ...options, capture: true }); + let match = regex.exec(posix ? utils.toPosixSlashes(input) : input); -/***/ }), + if (match) { + return match.slice(1).map(v => v === void 0 ? '' : v); + } +}; -/***/ "../../node_modules/execa/lib/error.js": -/***/ (function(module, exports, __webpack_require__) { +/** + * Create a regular expression from the given glob `pattern`. + * + * ```js + * const mm = require('micromatch'); + * // mm.makeRe(pattern[, options]); + * + * console.log(mm.makeRe('*.js')); + * //=> /^(?:(\.[\\\/])?(?!\.)(?=.)[^\/]*?\.js)$/ + * ``` + * @param {String} `pattern` A glob pattern to convert to regex. + * @param {Object} `options` + * @return {RegExp} Returns a regex created from the given pattern. + * @api public + */ -"use strict"; +micromatch.makeRe = (...args) => picomatch.makeRe(...args); -const {signalsByName} = __webpack_require__("../../node_modules/human-signals/build/src/main.js"); - -const getErrorPrefix = ({timedOut, timeout, errorCode, signal, signalDescription, exitCode, isCanceled}) => { - if (timedOut) { - return `timed out after ${timeout} milliseconds`; - } - - if (isCanceled) { - return 'was canceled'; - } - - if (errorCode !== undefined) { - return `failed with ${errorCode}`; - } +/** + * Scan a glob pattern to separate the pattern into segments. Used + * by the [split](#split) method. + * + * ```js + * const mm = require('micromatch'); + * const state = mm.scan(pattern[, options]); + * ``` + * @param {String} `pattern` + * @param {Object} `options` + * @return {Object} Returns an object with + * @api public + */ - if (signal !== undefined) { - return `was killed with ${signal} (${signalDescription})`; - } +micromatch.scan = (...args) => picomatch.scan(...args); - if (exitCode !== undefined) { - return `failed with exit code ${exitCode}`; - } +/** + * Parse a glob pattern to create the source string for a regular + * expression. + * + * ```js + * const mm = require('micromatch'); + * const state = mm(pattern[, options]); + * ``` + * @param {String} `glob` + * @param {Object} `options` + * @return {Object} Returns an object with useful properties and output to be used as regex source string. + * @api public + */ - return 'failed'; +micromatch.parse = (patterns, options) => { + let res = []; + for (let pattern of [].concat(patterns || [])) { + for (let str of braces(String(pattern), options)) { + res.push(picomatch.parse(str, options)); + } + } + return res; }; -const makeError = ({ - stdout, - stderr, - all, - error, - signal, - exitCode, - command, - timedOut, - isCanceled, - killed, - parsed: {options: {timeout}} -}) => { - // `signal` and `exitCode` emitted on `spawned.on('exit')` event can be `null`. - // We normalize them to `undefined` - exitCode = exitCode === null ? undefined : exitCode; - signal = signal === null ? undefined : signal; - const signalDescription = signal === undefined ? undefined : signalsByName[signal].description; - - const errorCode = error && error.code; - - const prefix = getErrorPrefix({timedOut, timeout, errorCode, signal, signalDescription, exitCode, isCanceled}); - const execaMessage = `Command ${prefix}: ${command}`; - const isError = Object.prototype.toString.call(error) === '[object Error]'; - const shortMessage = isError ? `${execaMessage}\n${error.message}` : execaMessage; - const message = [shortMessage, stderr, stdout].filter(Boolean).join('\n'); - - if (isError) { - error.originalMessage = error.message; - error.message = message; - } else { - error = new Error(message); - } - - error.shortMessage = shortMessage; - error.command = command; - error.exitCode = exitCode; - error.signal = signal; - error.signalDescription = signalDescription; - error.stdout = stdout; - error.stderr = stderr; - - if (all !== undefined) { - error.all = all; - } +/** + * Process the given brace `pattern`. + * + * ```js + * const { braces } = require('micromatch'); + * console.log(braces('foo/{a,b,c}/bar')); + * //=> [ 'foo/(a|b|c)/bar' ] + * + * console.log(braces('foo/{a,b,c}/bar', { expand: true })); + * //=> [ 'foo/a/bar', 'foo/b/bar', 'foo/c/bar' ] + * ``` + * @param {String} `pattern` String with brace pattern to process. + * @param {Object} `options` Any [options](#options) to change how expansion is performed. See the [braces][] library for all available options. + * @return {Array} + * @api public + */ - if ('bufferedData' in error) { - delete error.bufferedData; - } +micromatch.braces = (pattern, options) => { + if (typeof pattern !== 'string') throw new TypeError('Expected a string'); + if ((options && options.nobrace === true) || !/\{.*\}/.test(pattern)) { + return [pattern]; + } + return braces(pattern, options); +}; - error.failed = true; - error.timedOut = Boolean(timedOut); - error.isCanceled = isCanceled; - error.killed = killed && !timedOut; +/** + * Expand braces + */ - return error; +micromatch.braceExpand = (pattern, options) => { + if (typeof pattern !== 'string') throw new TypeError('Expected a string'); + return micromatch.braces(pattern, { ...options, expand: true }); }; -module.exports = makeError; +/** + * Expose micromatch + */ + +module.exports = micromatch; /***/ }), -/***/ "../../node_modules/execa/lib/kill.js": +/***/ "../../node_modules/fast-glob/out/index.js": /***/ (function(module, exports, __webpack_require__) { "use strict"; -const os = __webpack_require__("os"); -const onExit = __webpack_require__("../../node_modules/signal-exit/index.js"); - -const DEFAULT_FORCE_KILL_TIMEOUT = 1000 * 5; - -// Monkey-patches `childProcess.kill()` to add `forceKillAfterTimeout` behavior -const spawnedKill = (kill, signal = 'SIGTERM', options = {}) => { - const killResult = kill(signal); - setKillTimeout(kill, signal, options, killResult); - return killResult; -}; - -const setKillTimeout = (kill, signal, options, killResult) => { - if (!shouldForceKill(signal, options, killResult)) { - return; - } - - const timeout = getForceKillAfterTimeout(options); - const t = setTimeout(() => { - kill('SIGKILL'); - }, timeout); - - // Guarded because there's no `.unref()` when `execa` is used in the renderer - // process in Electron. This cannot be tested since we don't run tests in - // Electron. - // istanbul ignore else - if (t.unref) { - t.unref(); - } -}; - -const shouldForceKill = (signal, {forceKillAfterTimeout}, killResult) => { - return isSigterm(signal) && forceKillAfterTimeout !== false && killResult; -}; +const taskManager = __webpack_require__("../../node_modules/fast-glob/out/managers/tasks.js"); +const async_1 = __webpack_require__("../../node_modules/fast-glob/out/providers/async.js"); +const stream_1 = __webpack_require__("../../node_modules/fast-glob/out/providers/stream.js"); +const sync_1 = __webpack_require__("../../node_modules/fast-glob/out/providers/sync.js"); +const settings_1 = __webpack_require__("../../node_modules/fast-glob/out/settings.js"); +const utils = __webpack_require__("../../node_modules/fast-glob/out/utils/index.js"); +async function FastGlob(source, options) { + assertPatternsInput(source); + const works = getWorks(source, async_1.default, options); + const result = await Promise.all(works); + return utils.array.flatten(result); +} +// https://github.com/typescript-eslint/typescript-eslint/issues/60 +// eslint-disable-next-line no-redeclare +(function (FastGlob) { + function sync(source, options) { + assertPatternsInput(source); + const works = getWorks(source, sync_1.default, options); + return utils.array.flatten(works); + } + FastGlob.sync = sync; + function stream(source, options) { + assertPatternsInput(source); + const works = getWorks(source, stream_1.default, options); + /** + * The stream returned by the provider cannot work with an asynchronous iterator. + * To support asynchronous iterators, regardless of the number of tasks, we always multiplex streams. + * This affects performance (+25%). I don't see best solution right now. + */ + return utils.stream.merge(works); + } + FastGlob.stream = stream; + function generateTasks(source, options) { + assertPatternsInput(source); + const patterns = [].concat(source); + const settings = new settings_1.default(options); + return taskManager.generate(patterns, settings); + } + FastGlob.generateTasks = generateTasks; + function isDynamicPattern(source, options) { + assertPatternsInput(source); + const settings = new settings_1.default(options); + return utils.pattern.isDynamicPattern(source, settings); + } + FastGlob.isDynamicPattern = isDynamicPattern; + function escapePath(source) { + assertPatternsInput(source); + return utils.path.escape(source); + } + FastGlob.escapePath = escapePath; +})(FastGlob || (FastGlob = {})); +function getWorks(source, _Provider, options) { + const patterns = [].concat(source); + const settings = new settings_1.default(options); + const tasks = taskManager.generate(patterns, settings); + const provider = new _Provider(settings); + return tasks.map(provider.read, provider); +} +function assertPatternsInput(input) { + const source = [].concat(input); + const isValidSource = source.every((item) => utils.string.isString(item) && !utils.string.isEmpty(item)); + if (!isValidSource) { + throw new TypeError('Patterns must be a string (non empty) or an array of strings'); + } +} +module.exports = FastGlob; -const isSigterm = signal => { - return signal === os.constants.signals.SIGTERM || - (typeof signal === 'string' && signal.toUpperCase() === 'SIGTERM'); -}; -const getForceKillAfterTimeout = ({forceKillAfterTimeout = true}) => { - if (forceKillAfterTimeout === true) { - return DEFAULT_FORCE_KILL_TIMEOUT; - } +/***/ }), - if (!Number.isFinite(forceKillAfterTimeout) || forceKillAfterTimeout < 0) { - throw new TypeError(`Expected the \`forceKillAfterTimeout\` option to be a non-negative integer, got \`${forceKillAfterTimeout}\` (${typeof forceKillAfterTimeout})`); - } +/***/ "../../node_modules/fast-glob/out/managers/tasks.js": +/***/ (function(module, exports, __webpack_require__) { - return forceKillAfterTimeout; -}; +"use strict"; -// `childProcess.cancel()` -const spawnedCancel = (spawned, context) => { - const killResult = spawned.kill(); - - if (killResult) { - context.isCanceled = true; - } -}; - -const timeoutKill = (spawned, signal, reject) => { - spawned.kill(signal); - reject(Object.assign(new Error('Timed out'), {timedOut: true, signal})); -}; - -// `timeout` option handling -const setupTimeout = (spawned, {timeout, killSignal = 'SIGTERM'}, spawnedPromise) => { - if (timeout === 0 || timeout === undefined) { - return spawnedPromise; - } - - if (!Number.isFinite(timeout) || timeout < 0) { - throw new TypeError(`Expected the \`timeout\` option to be a non-negative integer, got \`${timeout}\` (${typeof timeout})`); - } - - let timeoutId; - const timeoutPromise = new Promise((resolve, reject) => { - timeoutId = setTimeout(() => { - timeoutKill(spawned, killSignal, reject); - }, timeout); - }); - - const safeSpawnedPromise = spawnedPromise.finally(() => { - clearTimeout(timeoutId); - }); +Object.defineProperty(exports, "__esModule", { value: true }); +exports.convertPatternGroupToTask = exports.convertPatternGroupsToTasks = exports.groupPatternsByBaseDirectory = exports.getNegativePatternsAsPositive = exports.getPositivePatterns = exports.convertPatternsToTasks = exports.generate = void 0; +const utils = __webpack_require__("../../node_modules/fast-glob/out/utils/index.js"); +function generate(patterns, settings) { + const positivePatterns = getPositivePatterns(patterns); + const negativePatterns = getNegativePatternsAsPositive(patterns, settings.ignore); + const staticPatterns = positivePatterns.filter((pattern) => utils.pattern.isStaticPattern(pattern, settings)); + const dynamicPatterns = positivePatterns.filter((pattern) => utils.pattern.isDynamicPattern(pattern, settings)); + const staticTasks = convertPatternsToTasks(staticPatterns, negativePatterns, /* dynamic */ false); + const dynamicTasks = convertPatternsToTasks(dynamicPatterns, negativePatterns, /* dynamic */ true); + return staticTasks.concat(dynamicTasks); +} +exports.generate = generate; +/** + * Returns tasks grouped by basic pattern directories. + * + * Patterns that can be found inside (`./`) and outside (`../`) the current directory are handled separately. + * This is necessary because directory traversal starts at the base directory and goes deeper. + */ +function convertPatternsToTasks(positive, negative, dynamic) { + const tasks = []; + const patternsOutsideCurrentDirectory = utils.pattern.getPatternsOutsideCurrentDirectory(positive); + const patternsInsideCurrentDirectory = utils.pattern.getPatternsInsideCurrentDirectory(positive); + const outsideCurrentDirectoryGroup = groupPatternsByBaseDirectory(patternsOutsideCurrentDirectory); + const insideCurrentDirectoryGroup = groupPatternsByBaseDirectory(patternsInsideCurrentDirectory); + tasks.push(...convertPatternGroupsToTasks(outsideCurrentDirectoryGroup, negative, dynamic)); + /* + * For the sake of reducing future accesses to the file system, we merge all tasks within the current directory + * into a global task, if at least one pattern refers to the root (`.`). In this case, the global task covers the rest. + */ + if ('.' in insideCurrentDirectoryGroup) { + tasks.push(convertPatternGroupToTask('.', patternsInsideCurrentDirectory, negative, dynamic)); + } + else { + tasks.push(...convertPatternGroupsToTasks(insideCurrentDirectoryGroup, negative, dynamic)); + } + return tasks; +} +exports.convertPatternsToTasks = convertPatternsToTasks; +function getPositivePatterns(patterns) { + return utils.pattern.getPositivePatterns(patterns); +} +exports.getPositivePatterns = getPositivePatterns; +function getNegativePatternsAsPositive(patterns, ignore) { + const negative = utils.pattern.getNegativePatterns(patterns).concat(ignore); + const positive = negative.map(utils.pattern.convertToPositivePattern); + return positive; +} +exports.getNegativePatternsAsPositive = getNegativePatternsAsPositive; +function groupPatternsByBaseDirectory(patterns) { + const group = {}; + return patterns.reduce((collection, pattern) => { + const base = utils.pattern.getBaseDirectory(pattern); + if (base in collection) { + collection[base].push(pattern); + } + else { + collection[base] = [pattern]; + } + return collection; + }, group); +} +exports.groupPatternsByBaseDirectory = groupPatternsByBaseDirectory; +function convertPatternGroupsToTasks(positive, negative, dynamic) { + return Object.keys(positive).map((base) => { + return convertPatternGroupToTask(base, positive[base], negative, dynamic); + }); +} +exports.convertPatternGroupsToTasks = convertPatternGroupsToTasks; +function convertPatternGroupToTask(base, positive, negative, dynamic) { + return { + dynamic, + positive, + negative, + base, + patterns: [].concat(positive, negative.map(utils.pattern.convertToNegativePattern)) + }; +} +exports.convertPatternGroupToTask = convertPatternGroupToTask; - return Promise.race([timeoutPromise, safeSpawnedPromise]); -}; -// `cleanup` option handling -const setExitHandler = async (spawned, {cleanup, detached}, timedPromise) => { - if (!cleanup || detached) { - return timedPromise; - } +/***/ }), - const removeExitHandler = onExit(() => { - spawned.kill(); - }); +/***/ "../../node_modules/fast-glob/out/providers/async.js": +/***/ (function(module, exports, __webpack_require__) { - return timedPromise.finally(() => { - removeExitHandler(); - }); -}; +"use strict"; -module.exports = { - spawnedKill, - spawnedCancel, - setupTimeout, - setExitHandler -}; +Object.defineProperty(exports, "__esModule", { value: true }); +const stream_1 = __webpack_require__("../../node_modules/fast-glob/out/readers/stream.js"); +const provider_1 = __webpack_require__("../../node_modules/fast-glob/out/providers/provider.js"); +class ProviderAsync extends provider_1.default { + constructor() { + super(...arguments); + this._reader = new stream_1.default(this._settings); + } + read(task) { + const root = this._getRootDirectory(task); + const options = this._getReaderOptions(task); + const entries = []; + return new Promise((resolve, reject) => { + const stream = this.api(root, task, options); + stream.once('error', reject); + stream.on('data', (entry) => entries.push(options.transform(entry))); + stream.once('end', () => resolve(entries)); + }); + } + api(root, task, options) { + if (task.dynamic) { + return this._reader.dynamic(root, options); + } + return this._reader.static(task.patterns, options); + } +} +exports.default = ProviderAsync; /***/ }), -/***/ "../../node_modules/execa/lib/promise.js": +/***/ "../../node_modules/fast-glob/out/providers/filters/deep.js": /***/ (function(module, exports, __webpack_require__) { "use strict"; +Object.defineProperty(exports, "__esModule", { value: true }); +const utils = __webpack_require__("../../node_modules/fast-glob/out/utils/index.js"); +const partial_1 = __webpack_require__("../../node_modules/fast-glob/out/providers/matchers/partial.js"); +class DeepFilter { + constructor(_settings, _micromatchOptions) { + this._settings = _settings; + this._micromatchOptions = _micromatchOptions; + } + getFilter(basePath, positive, negative) { + const matcher = this._getMatcher(positive); + const negativeRe = this._getNegativePatternsRe(negative); + return (entry) => this._filter(basePath, entry, matcher, negativeRe); + } + _getMatcher(patterns) { + return new partial_1.default(patterns, this._settings, this._micromatchOptions); + } + _getNegativePatternsRe(patterns) { + const affectDepthOfReadingPatterns = patterns.filter(utils.pattern.isAffectDepthOfReadingPattern); + return utils.pattern.convertPatternsToRe(affectDepthOfReadingPatterns, this._micromatchOptions); + } + _filter(basePath, entry, matcher, negativeRe) { + if (this._isSkippedByDeep(basePath, entry.path)) { + return false; + } + if (this._isSkippedSymbolicLink(entry)) { + return false; + } + const filepath = utils.path.removeLeadingDotSegment(entry.path); + if (this._isSkippedByPositivePatterns(filepath, matcher)) { + return false; + } + return this._isSkippedByNegativePatterns(filepath, negativeRe); + } + _isSkippedByDeep(basePath, entryPath) { + /** + * Avoid unnecessary depth calculations when it doesn't matter. + */ + if (this._settings.deep === Infinity) { + return false; + } + return this._getEntryLevel(basePath, entryPath) >= this._settings.deep; + } + _getEntryLevel(basePath, entryPath) { + const entryPathDepth = entryPath.split('/').length; + if (basePath === '') { + return entryPathDepth; + } + const basePathDepth = basePath.split('/').length; + return entryPathDepth - basePathDepth; + } + _isSkippedSymbolicLink(entry) { + return !this._settings.followSymbolicLinks && entry.dirent.isSymbolicLink(); + } + _isSkippedByPositivePatterns(entryPath, matcher) { + return !this._settings.baseNameMatch && !matcher.match(entryPath); + } + _isSkippedByNegativePatterns(entryPath, patternsRe) { + return !utils.pattern.matchAny(entryPath, patternsRe); + } +} +exports.default = DeepFilter; -const nativePromisePrototype = (async () => {})().constructor.prototype; -const descriptors = ['then', 'catch', 'finally'].map(property => [ - property, - Reflect.getOwnPropertyDescriptor(nativePromisePrototype, property) -]); - -// The return value is a mixin of `childProcess` and `Promise` -const mergePromise = (spawned, promise) => { - for (const [property, descriptor] of descriptors) { - // Starting the main `promise` is deferred to avoid consuming streams - const value = typeof promise === 'function' ? - (...args) => Reflect.apply(descriptor.value, promise(), args) : - descriptor.value.bind(promise); - - Reflect.defineProperty(spawned, property, {...descriptor, value}); - } - - return spawned; -}; -// Use promises instead of `child_process` events -const getSpawnedPromise = spawned => { - return new Promise((resolve, reject) => { - spawned.on('exit', (exitCode, signal) => { - resolve({exitCode, signal}); - }); +/***/ }), - spawned.on('error', error => { - reject(error); - }); +/***/ "../../node_modules/fast-glob/out/providers/filters/entry.js": +/***/ (function(module, exports, __webpack_require__) { - if (spawned.stdin) { - spawned.stdin.on('error', error => { - reject(error); - }); - } - }); -}; - -module.exports = { - mergePromise, - getSpawnedPromise -}; +"use strict"; +Object.defineProperty(exports, "__esModule", { value: true }); +const utils = __webpack_require__("../../node_modules/fast-glob/out/utils/index.js"); +class EntryFilter { + constructor(_settings, _micromatchOptions) { + this._settings = _settings; + this._micromatchOptions = _micromatchOptions; + this.index = new Map(); + } + getFilter(positive, negative) { + const positiveRe = utils.pattern.convertPatternsToRe(positive, this._micromatchOptions); + const negativeRe = utils.pattern.convertPatternsToRe(negative, this._micromatchOptions); + return (entry) => this._filter(entry, positiveRe, negativeRe); + } + _filter(entry, positiveRe, negativeRe) { + if (this._settings.unique && this._isDuplicateEntry(entry)) { + return false; + } + if (this._onlyFileFilter(entry) || this._onlyDirectoryFilter(entry)) { + return false; + } + if (this._isSkippedByAbsoluteNegativePatterns(entry.path, negativeRe)) { + return false; + } + const filepath = this._settings.baseNameMatch ? entry.name : entry.path; + const isMatched = this._isMatchToPatterns(filepath, positiveRe) && !this._isMatchToPatterns(entry.path, negativeRe); + if (this._settings.unique && isMatched) { + this._createIndexRecord(entry); + } + return isMatched; + } + _isDuplicateEntry(entry) { + return this.index.has(entry.path); + } + _createIndexRecord(entry) { + this.index.set(entry.path, undefined); + } + _onlyFileFilter(entry) { + return this._settings.onlyFiles && !entry.dirent.isFile(); + } + _onlyDirectoryFilter(entry) { + return this._settings.onlyDirectories && !entry.dirent.isDirectory(); + } + _isSkippedByAbsoluteNegativePatterns(entryPath, patternsRe) { + if (!this._settings.absolute) { + return false; + } + const fullpath = utils.path.makeAbsolute(this._settings.cwd, entryPath); + return utils.pattern.matchAny(fullpath, patternsRe); + } + _isMatchToPatterns(entryPath, patternsRe) { + const filepath = utils.path.removeLeadingDotSegment(entryPath); + return utils.pattern.matchAny(filepath, patternsRe); + } +} +exports.default = EntryFilter; /***/ }), -/***/ "../../node_modules/execa/lib/stdio.js": +/***/ "../../node_modules/fast-glob/out/providers/filters/error.js": /***/ (function(module, exports, __webpack_require__) { "use strict"; -const aliases = ['stdin', 'stdout', 'stderr']; +Object.defineProperty(exports, "__esModule", { value: true }); +const utils = __webpack_require__("../../node_modules/fast-glob/out/utils/index.js"); +class ErrorFilter { + constructor(_settings) { + this._settings = _settings; + } + getFilter() { + return (error) => this._isNonFatalError(error); + } + _isNonFatalError(error) { + return utils.errno.isEnoentCodeError(error) || this._settings.suppressErrors; + } +} +exports.default = ErrorFilter; -const hasAlias = opts => aliases.some(alias => opts[alias] !== undefined); -const normalizeStdio = opts => { - if (!opts) { - return; - } +/***/ }), - const {stdio} = opts; +/***/ "../../node_modules/fast-glob/out/providers/matchers/matcher.js": +/***/ (function(module, exports, __webpack_require__) { - if (stdio === undefined) { - return aliases.map(alias => opts[alias]); - } +"use strict"; - if (hasAlias(opts)) { - throw new Error(`It's not possible to provide \`stdio\` in combination with one of ${aliases.map(alias => `\`${alias}\``).join(', ')}`); - } +Object.defineProperty(exports, "__esModule", { value: true }); +const utils = __webpack_require__("../../node_modules/fast-glob/out/utils/index.js"); +class Matcher { + constructor(_patterns, _settings, _micromatchOptions) { + this._patterns = _patterns; + this._settings = _settings; + this._micromatchOptions = _micromatchOptions; + this._storage = []; + this._fillStorage(); + } + _fillStorage() { + /** + * The original pattern may include `{,*,**,a/*}`, which will lead to problems with matching (unresolved level). + * So, before expand patterns with brace expansion into separated patterns. + */ + const patterns = utils.pattern.expandPatternsWithBraceExpansion(this._patterns); + for (const pattern of patterns) { + const segments = this._getPatternSegments(pattern); + const sections = this._splitSegmentsIntoSections(segments); + this._storage.push({ + complete: sections.length <= 1, + pattern, + segments, + sections + }); + } + } + _getPatternSegments(pattern) { + const parts = utils.pattern.getPatternParts(pattern, this._micromatchOptions); + return parts.map((part) => { + const dynamic = utils.pattern.isDynamicPattern(part, this._settings); + if (!dynamic) { + return { + dynamic: false, + pattern: part + }; + } + return { + dynamic: true, + pattern: part, + patternRe: utils.pattern.makeRe(part, this._micromatchOptions) + }; + }); + } + _splitSegmentsIntoSections(segments) { + return utils.array.splitWhen(segments, (segment) => segment.dynamic && utils.pattern.hasGlobStar(segment.pattern)); + } +} +exports.default = Matcher; - if (typeof stdio === 'string') { - return stdio; - } - if (!Array.isArray(stdio)) { - throw new TypeError(`Expected \`stdio\` to be of type \`string\` or \`Array\`, got \`${typeof stdio}\``); - } +/***/ }), - const length = Math.max(stdio.length, aliases.length); - return Array.from({length}, (value, index) => stdio[index]); -}; +/***/ "../../node_modules/fast-glob/out/providers/matchers/partial.js": +/***/ (function(module, exports, __webpack_require__) { -module.exports = normalizeStdio; +"use strict"; -// `ipc` is pushed unless it is already present -module.exports.node = opts => { - const stdio = normalizeStdio(opts); +Object.defineProperty(exports, "__esModule", { value: true }); +const matcher_1 = __webpack_require__("../../node_modules/fast-glob/out/providers/matchers/matcher.js"); +class PartialMatcher extends matcher_1.default { + match(filepath) { + const parts = filepath.split('/'); + const levels = parts.length; + const patterns = this._storage.filter((info) => !info.complete || info.segments.length > levels); + for (const pattern of patterns) { + const section = pattern.sections[0]; + /** + * In this case, the pattern has a globstar and we must read all directories unconditionally, + * but only if the level has reached the end of the first group. + * + * fixtures/{a,b}/** + * ^ true/false ^ always true + */ + if (!pattern.complete && levels > section.length) { + return true; + } + const match = parts.every((part, index) => { + const segment = pattern.segments[index]; + if (segment.dynamic && segment.patternRe.test(part)) { + return true; + } + if (!segment.dynamic && segment.pattern === part) { + return true; + } + return false; + }); + if (match) { + return true; + } + } + return false; + } +} +exports.default = PartialMatcher; - if (stdio === 'ipc') { - return 'ipc'; - } - if (stdio === undefined || typeof stdio === 'string') { - return [stdio, stdio, stdio, 'ipc']; - } +/***/ }), - if (stdio.includes('ipc')) { - return stdio; - } +/***/ "../../node_modules/fast-glob/out/providers/provider.js": +/***/ (function(module, exports, __webpack_require__) { - return [...stdio, 'ipc']; -}; +"use strict"; + +Object.defineProperty(exports, "__esModule", { value: true }); +const path = __webpack_require__("path"); +const deep_1 = __webpack_require__("../../node_modules/fast-glob/out/providers/filters/deep.js"); +const entry_1 = __webpack_require__("../../node_modules/fast-glob/out/providers/filters/entry.js"); +const error_1 = __webpack_require__("../../node_modules/fast-glob/out/providers/filters/error.js"); +const entry_2 = __webpack_require__("../../node_modules/fast-glob/out/providers/transformers/entry.js"); +class Provider { + constructor(_settings) { + this._settings = _settings; + this.errorFilter = new error_1.default(this._settings); + this.entryFilter = new entry_1.default(this._settings, this._getMicromatchOptions()); + this.deepFilter = new deep_1.default(this._settings, this._getMicromatchOptions()); + this.entryTransformer = new entry_2.default(this._settings); + } + _getRootDirectory(task) { + return path.resolve(this._settings.cwd, task.base); + } + _getReaderOptions(task) { + const basePath = task.base === '.' ? '' : task.base; + return { + basePath, + pathSegmentSeparator: '/', + concurrency: this._settings.concurrency, + deepFilter: this.deepFilter.getFilter(basePath, task.positive, task.negative), + entryFilter: this.entryFilter.getFilter(task.positive, task.negative), + errorFilter: this.errorFilter.getFilter(), + followSymbolicLinks: this._settings.followSymbolicLinks, + fs: this._settings.fs, + stats: this._settings.stats, + throwErrorOnBrokenSymbolicLink: this._settings.throwErrorOnBrokenSymbolicLink, + transform: this.entryTransformer.getTransformer() + }; + } + _getMicromatchOptions() { + return { + dot: this._settings.dot, + matchBase: this._settings.baseNameMatch, + nobrace: !this._settings.braceExpansion, + nocase: !this._settings.caseSensitiveMatch, + noext: !this._settings.extglob, + noglobstar: !this._settings.globstar, + posix: true, + strictSlashes: false + }; + } +} +exports.default = Provider; /***/ }), -/***/ "../../node_modules/execa/lib/stream.js": +/***/ "../../node_modules/fast-glob/out/providers/stream.js": /***/ (function(module, exports, __webpack_require__) { "use strict"; -const isStream = __webpack_require__("../../node_modules/is-stream/index.js"); -const getStream = __webpack_require__("../../node_modules/get-stream/index.js"); -const mergeStream = __webpack_require__("../../node_modules/merge-stream/index.js"); - -// `input` option -const handleInput = (spawned, input) => { - // Checking for stdin is workaround for https://github.com/nodejs/node/issues/26852 - // TODO: Remove `|| spawned.stdin === undefined` once we drop support for Node.js <=12.2.0 - if (input === undefined || spawned.stdin === undefined) { - return; - } - - if (isStream(input)) { - input.pipe(spawned.stdin); - } else { - spawned.stdin.end(input); - } -}; - -// `all` interleaves `stdout` and `stderr` -const makeAllStream = (spawned, {all}) => { - if (!all || (!spawned.stdout && !spawned.stderr)) { - return; - } +Object.defineProperty(exports, "__esModule", { value: true }); +const stream_1 = __webpack_require__("stream"); +const stream_2 = __webpack_require__("../../node_modules/fast-glob/out/readers/stream.js"); +const provider_1 = __webpack_require__("../../node_modules/fast-glob/out/providers/provider.js"); +class ProviderStream extends provider_1.default { + constructor() { + super(...arguments); + this._reader = new stream_2.default(this._settings); + } + read(task) { + const root = this._getRootDirectory(task); + const options = this._getReaderOptions(task); + const source = this.api(root, task, options); + const destination = new stream_1.Readable({ objectMode: true, read: () => { } }); + source + .once('error', (error) => destination.emit('error', error)) + .on('data', (entry) => destination.emit('data', options.transform(entry))) + .once('end', () => destination.emit('end')); + destination + .once('close', () => source.destroy()); + return destination; + } + api(root, task, options) { + if (task.dynamic) { + return this._reader.dynamic(root, options); + } + return this._reader.static(task.patterns, options); + } +} +exports.default = ProviderStream; - const mixed = mergeStream(); - if (spawned.stdout) { - mixed.add(spawned.stdout); - } +/***/ }), - if (spawned.stderr) { - mixed.add(spawned.stderr); - } +/***/ "../../node_modules/fast-glob/out/providers/sync.js": +/***/ (function(module, exports, __webpack_require__) { - return mixed; -}; +"use strict"; -// On failure, `result.stdout|stderr|all` should contain the currently buffered stream -const getBufferedData = async (stream, streamPromise) => { - if (!stream) { - return; - } +Object.defineProperty(exports, "__esModule", { value: true }); +const sync_1 = __webpack_require__("../../node_modules/fast-glob/out/readers/sync.js"); +const provider_1 = __webpack_require__("../../node_modules/fast-glob/out/providers/provider.js"); +class ProviderSync extends provider_1.default { + constructor() { + super(...arguments); + this._reader = new sync_1.default(this._settings); + } + read(task) { + const root = this._getRootDirectory(task); + const options = this._getReaderOptions(task); + const entries = this.api(root, task, options); + return entries.map(options.transform); + } + api(root, task, options) { + if (task.dynamic) { + return this._reader.dynamic(root, options); + } + return this._reader.static(task.patterns, options); + } +} +exports.default = ProviderSync; - stream.destroy(); - try { - return await streamPromise; - } catch (error) { - return error.bufferedData; - } -}; +/***/ }), -const getStreamPromise = (stream, {encoding, buffer, maxBuffer}) => { - if (!stream || !buffer) { - return; - } +/***/ "../../node_modules/fast-glob/out/providers/transformers/entry.js": +/***/ (function(module, exports, __webpack_require__) { - if (encoding) { - return getStream(stream, {encoding, maxBuffer}); - } +"use strict"; - return getStream.buffer(stream, {maxBuffer}); -}; +Object.defineProperty(exports, "__esModule", { value: true }); +const utils = __webpack_require__("../../node_modules/fast-glob/out/utils/index.js"); +class EntryTransformer { + constructor(_settings) { + this._settings = _settings; + } + getTransformer() { + return (entry) => this._transform(entry); + } + _transform(entry) { + let filepath = entry.path; + if (this._settings.absolute) { + filepath = utils.path.makeAbsolute(this._settings.cwd, filepath); + filepath = utils.path.unixify(filepath); + } + if (this._settings.markDirectories && entry.dirent.isDirectory()) { + filepath += '/'; + } + if (!this._settings.objectMode) { + return filepath; + } + return Object.assign(Object.assign({}, entry), { path: filepath }); + } +} +exports.default = EntryTransformer; -// Retrieve result of child process: exit code, signal, error, streams (stdout/stderr/all) -const getSpawnedResult = async ({stdout, stderr, all}, {encoding, buffer, maxBuffer}, processDone) => { - const stdoutPromise = getStreamPromise(stdout, {encoding, buffer, maxBuffer}); - const stderrPromise = getStreamPromise(stderr, {encoding, buffer, maxBuffer}); - const allPromise = getStreamPromise(all, {encoding, buffer, maxBuffer: maxBuffer * 2}); - try { - return await Promise.all([processDone, stdoutPromise, stderrPromise, allPromise]); - } catch (error) { - return Promise.all([ - {error, signal: error.signal, timedOut: error.timedOut}, - getBufferedData(stdout, stdoutPromise), - getBufferedData(stderr, stderrPromise), - getBufferedData(all, allPromise) - ]); - } -}; +/***/ }), -const validateInputSync = ({input}) => { - if (isStream(input)) { - throw new TypeError('The `input` option cannot be a stream in sync mode'); - } -}; +/***/ "../../node_modules/fast-glob/out/readers/reader.js": +/***/ (function(module, exports, __webpack_require__) { -module.exports = { - handleInput, - makeAllStream, - getSpawnedResult, - validateInputSync -}; +"use strict"; +Object.defineProperty(exports, "__esModule", { value: true }); +const path = __webpack_require__("path"); +const fsStat = __webpack_require__("../../node_modules/@nodelib/fs.stat/out/index.js"); +const utils = __webpack_require__("../../node_modules/fast-glob/out/utils/index.js"); +class Reader { + constructor(_settings) { + this._settings = _settings; + this._fsStatSettings = new fsStat.Settings({ + followSymbolicLink: this._settings.followSymbolicLinks, + fs: this._settings.fs, + throwErrorOnBrokenSymbolicLink: this._settings.followSymbolicLinks + }); + } + _getFullEntryPath(filepath) { + return path.resolve(this._settings.cwd, filepath); + } + _makeEntry(stats, pattern) { + const entry = { + name: pattern, + path: pattern, + dirent: utils.fs.createDirentFromStats(pattern, stats) + }; + if (this._settings.stats) { + entry.stats = stats; + } + return entry; + } + _isFatalError(error) { + return !utils.errno.isEnoentCodeError(error) && !this._settings.suppressErrors; + } +} +exports.default = Reader; /***/ }), -/***/ "../../node_modules/fastq/queue.js": +/***/ "../../node_modules/fast-glob/out/readers/stream.js": /***/ (function(module, exports, __webpack_require__) { "use strict"; +Object.defineProperty(exports, "__esModule", { value: true }); +const stream_1 = __webpack_require__("stream"); +const fsStat = __webpack_require__("../../node_modules/@nodelib/fs.stat/out/index.js"); +const fsWalk = __webpack_require__("../../node_modules/@nodelib/fs.walk/out/index.js"); +const reader_1 = __webpack_require__("../../node_modules/fast-glob/out/readers/reader.js"); +class ReaderStream extends reader_1.default { + constructor() { + super(...arguments); + this._walkStream = fsWalk.walkStream; + this._stat = fsStat.stat; + } + dynamic(root, options) { + return this._walkStream(root, options); + } + static(patterns, options) { + const filepaths = patterns.map(this._getFullEntryPath, this); + const stream = new stream_1.PassThrough({ objectMode: true }); + stream._write = (index, _enc, done) => { + return this._getEntry(filepaths[index], patterns[index], options) + .then((entry) => { + if (entry !== null && options.entryFilter(entry)) { + stream.push(entry); + } + if (index === filepaths.length - 1) { + stream.end(); + } + done(); + }) + .catch(done); + }; + for (let i = 0; i < filepaths.length; i++) { + stream.write(i); + } + return stream; + } + _getEntry(filepath, pattern, options) { + return this._getStat(filepath) + .then((stats) => this._makeEntry(stats, pattern)) + .catch((error) => { + if (options.errorFilter(error)) { + return null; + } + throw error; + }); + } + _getStat(filepath) { + return new Promise((resolve, reject) => { + this._stat(filepath, this._fsStatSettings, (error, stats) => { + return error === null ? resolve(stats) : reject(error); + }); + }); + } +} +exports.default = ReaderStream; -var reusify = __webpack_require__("../../node_modules/reusify/reusify.js") -function fastqueue (context, worker, concurrency) { - if (typeof context === 'function') { - concurrency = worker - worker = context - context = null - } +/***/ }), - var cache = reusify(Task) - var queueHead = null - var queueTail = null - var _running = 0 +/***/ "../../node_modules/fast-glob/out/readers/sync.js": +/***/ (function(module, exports, __webpack_require__) { - var self = { - push: push, - drain: noop, - saturated: noop, - pause: pause, - paused: false, - concurrency: concurrency, - running: running, - resume: resume, - idle: idle, - length: length, - unshift: unshift, - empty: noop, - kill: kill, - killAndDrain: killAndDrain - } - - return self - - function running () { - return _running - } - - function pause () { - self.paused = true - } - - function length () { - var current = queueHead - var counter = 0 +"use strict"; - while (current) { - current = current.next - counter++ +Object.defineProperty(exports, "__esModule", { value: true }); +const fsStat = __webpack_require__("../../node_modules/@nodelib/fs.stat/out/index.js"); +const fsWalk = __webpack_require__("../../node_modules/@nodelib/fs.walk/out/index.js"); +const reader_1 = __webpack_require__("../../node_modules/fast-glob/out/readers/reader.js"); +class ReaderSync extends reader_1.default { + constructor() { + super(...arguments); + this._walkSync = fsWalk.walkSync; + this._statSync = fsStat.statSync; } - - return counter - } - - function resume () { - if (!self.paused) return - self.paused = false - for (var i = 0; i < self.concurrency; i++) { - _running++ - release() + dynamic(root, options) { + return this._walkSync(root, options); } - } - - function idle () { - return _running === 0 && self.length() === 0 - } - - function push (value, done) { - var current = cache.get() - - current.context = context - current.release = release - current.value = value - current.callback = done || noop - - if (_running === self.concurrency || self.paused) { - if (queueTail) { - queueTail.next = current - queueTail = current - } else { - queueHead = current - queueTail = current - self.saturated() - } - } else { - _running++ - worker.call(context, current.value, current.worked) + static(patterns, options) { + const entries = []; + for (const pattern of patterns) { + const filepath = this._getFullEntryPath(pattern); + const entry = this._getEntry(filepath, pattern, options); + if (entry === null || !options.entryFilter(entry)) { + continue; + } + entries.push(entry); + } + return entries; } - } + _getEntry(filepath, pattern, options) { + try { + const stats = this._getStat(filepath); + return this._makeEntry(stats, pattern); + } + catch (error) { + if (options.errorFilter(error)) { + return null; + } + throw error; + } + } + _getStat(filepath) { + return this._statSync(filepath, this._fsStatSettings); + } +} +exports.default = ReaderSync; - function unshift (value, done) { - var current = cache.get() - current.context = context - current.release = release - current.value = value - current.callback = done || noop +/***/ }), - if (_running === self.concurrency || self.paused) { - if (queueHead) { - current.next = queueHead - queueHead = current - } else { - queueHead = current - queueTail = current - self.saturated() - } - } else { - _running++ - worker.call(context, current.value, current.worked) - } - } +/***/ "../../node_modules/fast-glob/out/settings.js": +/***/ (function(module, exports, __webpack_require__) { - function release (holder) { - if (holder) { - cache.release(holder) - } - var next = queueHead - if (next) { - if (!self.paused) { - if (queueTail === queueHead) { - queueTail = null +"use strict"; + +Object.defineProperty(exports, "__esModule", { value: true }); +exports.DEFAULT_FILE_SYSTEM_ADAPTER = void 0; +const fs = __webpack_require__("fs"); +const os = __webpack_require__("os"); +/** + * The `os.cpus` method can return zero. We expect the number of cores to be greater than zero. + * https://github.com/nodejs/node/blob/7faeddf23a98c53896f8b574a6e66589e8fb1eb8/lib/os.js#L106-L107 + */ +const CPU_COUNT = Math.max(os.cpus().length, 1); +exports.DEFAULT_FILE_SYSTEM_ADAPTER = { + lstat: fs.lstat, + lstatSync: fs.lstatSync, + stat: fs.stat, + statSync: fs.statSync, + readdir: fs.readdir, + readdirSync: fs.readdirSync +}; +class Settings { + constructor(_options = {}) { + this._options = _options; + this.absolute = this._getValue(this._options.absolute, false); + this.baseNameMatch = this._getValue(this._options.baseNameMatch, false); + this.braceExpansion = this._getValue(this._options.braceExpansion, true); + this.caseSensitiveMatch = this._getValue(this._options.caseSensitiveMatch, true); + this.concurrency = this._getValue(this._options.concurrency, CPU_COUNT); + this.cwd = this._getValue(this._options.cwd, process.cwd()); + this.deep = this._getValue(this._options.deep, Infinity); + this.dot = this._getValue(this._options.dot, false); + this.extglob = this._getValue(this._options.extglob, true); + this.followSymbolicLinks = this._getValue(this._options.followSymbolicLinks, true); + this.fs = this._getFileSystemMethods(this._options.fs); + this.globstar = this._getValue(this._options.globstar, true); + this.ignore = this._getValue(this._options.ignore, []); + this.markDirectories = this._getValue(this._options.markDirectories, false); + this.objectMode = this._getValue(this._options.objectMode, false); + this.onlyDirectories = this._getValue(this._options.onlyDirectories, false); + this.onlyFiles = this._getValue(this._options.onlyFiles, true); + this.stats = this._getValue(this._options.stats, false); + this.suppressErrors = this._getValue(this._options.suppressErrors, false); + this.throwErrorOnBrokenSymbolicLink = this._getValue(this._options.throwErrorOnBrokenSymbolicLink, false); + this.unique = this._getValue(this._options.unique, true); + if (this.onlyDirectories) { + this.onlyFiles = false; } - queueHead = next.next - next.next = null - worker.call(context, next.value, next.worked) - if (queueTail === null) { - self.empty() + if (this.stats) { + this.objectMode = true; } - } else { - _running-- - } - } else if (--_running === 0) { - self.drain() } - } - - function kill () { - queueHead = null - queueTail = null - self.drain = noop - } - - function killAndDrain () { - queueHead = null - queueTail = null - self.drain() - self.drain = noop - } + _getValue(option, value) { + return option === undefined ? value : option; + } + _getFileSystemMethods(methods = {}) { + return Object.assign(Object.assign({}, exports.DEFAULT_FILE_SYSTEM_ADAPTER), methods); + } } +exports.default = Settings; -function noop () {} -function Task () { - this.value = null - this.callback = noop - this.next = null - this.release = noop - this.context = null +/***/ }), - var self = this +/***/ "../../node_modules/fast-glob/out/utils/array.js": +/***/ (function(module, exports, __webpack_require__) { - this.worked = function worked (err, result) { - var callback = self.callback - self.value = null - self.callback = noop - callback.call(self.context, err, result) - self.release(self) - } -} +"use strict"; -module.exports = fastqueue +Object.defineProperty(exports, "__esModule", { value: true }); +exports.splitWhen = exports.flatten = void 0; +function flatten(items) { + return items.reduce((collection, item) => [].concat(collection, item), []); +} +exports.flatten = flatten; +function splitWhen(items, predicate) { + const result = [[]]; + let groupIndex = 0; + for (const item of items) { + if (predicate(item)) { + groupIndex++; + result[groupIndex] = []; + } + else { + result[groupIndex].push(item); + } + } + return result; +} +exports.splitWhen = splitWhen; /***/ }), -/***/ "../../node_modules/fill-range/index.js": +/***/ "../../node_modules/fast-glob/out/utils/errno.js": /***/ (function(module, exports, __webpack_require__) { "use strict"; -/*! - * fill-range - * - * Copyright (c) 2014-present, Jon Schlinkert. - * Licensed under the MIT License. - */ - - - -const util = __webpack_require__("util"); -const toRegexRange = __webpack_require__("../../node_modules/to-regex-range/index.js"); - -const isObject = val => val !== null && typeof val === 'object' && !Array.isArray(val); - -const transform = toNumber => { - return value => toNumber === true ? Number(value) : String(value); -}; - -const isValidValue = value => { - return typeof value === 'number' || (typeof value === 'string' && value !== ''); -}; - -const isNumber = num => Number.isInteger(+num); - -const zeros = input => { - let value = `${input}`; - let index = -1; - if (value[0] === '-') value = value.slice(1); - if (value === '0') return false; - while (value[++index] === '0'); - return index > 0; -}; - -const stringify = (start, end, options) => { - if (typeof start === 'string' || typeof end === 'string') { - return true; - } - return options.stringify === true; -}; - -const pad = (input, maxLength, toNumber) => { - if (maxLength > 0) { - let dash = input[0] === '-' ? '-' : ''; - if (dash) input = input.slice(1); - input = (dash + input.padStart(dash ? maxLength - 1 : maxLength, '0')); - } - if (toNumber === false) { - return String(input); - } - return input; -}; - -const toMaxLen = (input, maxLength) => { - let negative = input[0] === '-' ? '-' : ''; - if (negative) { - input = input.slice(1); - maxLength--; - } - while (input.length < maxLength) input = '0' + input; - return negative ? ('-' + input) : input; -}; - -const toSequence = (parts, options) => { - parts.negatives.sort((a, b) => a < b ? -1 : a > b ? 1 : 0); - parts.positives.sort((a, b) => a < b ? -1 : a > b ? 1 : 0); - - let prefix = options.capture ? '' : '?:'; - let positives = ''; - let negatives = ''; - let result; - - if (parts.positives.length) { - positives = parts.positives.join('|'); - } - - if (parts.negatives.length) { - negatives = `-(${prefix}${parts.negatives.join('|')})`; - } - - if (positives && negatives) { - result = `${positives}|${negatives}`; - } else { - result = positives || negatives; - } - - if (options.wrap) { - return `(${prefix}${result})`; - } - return result; -}; +Object.defineProperty(exports, "__esModule", { value: true }); +exports.isEnoentCodeError = void 0; +function isEnoentCodeError(error) { + return error.code === 'ENOENT'; +} +exports.isEnoentCodeError = isEnoentCodeError; -const toRange = (a, b, isNumbers, options) => { - if (isNumbers) { - return toRegexRange(a, b, { wrap: false, ...options }); - } - let start = String.fromCharCode(a); - if (a === b) return start; +/***/ }), - let stop = String.fromCharCode(b); - return `[${start}-${stop}]`; -}; +/***/ "../../node_modules/fast-glob/out/utils/fs.js": +/***/ (function(module, exports, __webpack_require__) { -const toRegex = (start, end, options) => { - if (Array.isArray(start)) { - let wrap = options.wrap === true; - let prefix = options.capture ? '' : '?:'; - return wrap ? `(${prefix}${start.join('|')})` : start.join('|'); - } - return toRegexRange(start, end, options); -}; +"use strict"; -const rangeError = (...args) => { - return new RangeError('Invalid range arguments: ' + util.inspect(...args)); -}; +Object.defineProperty(exports, "__esModule", { value: true }); +exports.createDirentFromStats = void 0; +class DirentFromStats { + constructor(name, stats) { + this.name = name; + this.isBlockDevice = stats.isBlockDevice.bind(stats); + this.isCharacterDevice = stats.isCharacterDevice.bind(stats); + this.isDirectory = stats.isDirectory.bind(stats); + this.isFIFO = stats.isFIFO.bind(stats); + this.isFile = stats.isFile.bind(stats); + this.isSocket = stats.isSocket.bind(stats); + this.isSymbolicLink = stats.isSymbolicLink.bind(stats); + } +} +function createDirentFromStats(name, stats) { + return new DirentFromStats(name, stats); +} +exports.createDirentFromStats = createDirentFromStats; -const invalidRange = (start, end, options) => { - if (options.strictRanges === true) throw rangeError([start, end]); - return []; -}; -const invalidStep = (step, options) => { - if (options.strictRanges === true) { - throw new TypeError(`Expected step "${step}" to be a number`); - } - return []; -}; +/***/ }), -const fillNumbers = (start, end, step = 1, options = {}) => { - let a = Number(start); - let b = Number(end); +/***/ "../../node_modules/fast-glob/out/utils/index.js": +/***/ (function(module, exports, __webpack_require__) { - if (!Number.isInteger(a) || !Number.isInteger(b)) { - if (options.strictRanges === true) throw rangeError([start, end]); - return []; - } +"use strict"; - // fix negative zero - if (a === 0) a = 0; - if (b === 0) b = 0; +Object.defineProperty(exports, "__esModule", { value: true }); +exports.string = exports.stream = exports.pattern = exports.path = exports.fs = exports.errno = exports.array = void 0; +const array = __webpack_require__("../../node_modules/fast-glob/out/utils/array.js"); +exports.array = array; +const errno = __webpack_require__("../../node_modules/fast-glob/out/utils/errno.js"); +exports.errno = errno; +const fs = __webpack_require__("../../node_modules/fast-glob/out/utils/fs.js"); +exports.fs = fs; +const path = __webpack_require__("../../node_modules/fast-glob/out/utils/path.js"); +exports.path = path; +const pattern = __webpack_require__("../../node_modules/fast-glob/out/utils/pattern.js"); +exports.pattern = pattern; +const stream = __webpack_require__("../../node_modules/fast-glob/out/utils/stream.js"); +exports.stream = stream; +const string = __webpack_require__("../../node_modules/fast-glob/out/utils/string.js"); +exports.string = string; - let descending = a > b; - let startString = String(start); - let endString = String(end); - let stepString = String(step); - step = Math.max(Math.abs(step), 1); - let padded = zeros(startString) || zeros(endString) || zeros(stepString); - let maxLen = padded ? Math.max(startString.length, endString.length, stepString.length) : 0; - let toNumber = padded === false && stringify(start, end, options) === false; - let format = options.transform || transform(toNumber); +/***/ }), - if (options.toRegex && step === 1) { - return toRange(toMaxLen(start, maxLen), toMaxLen(end, maxLen), true, options); - } +/***/ "../../node_modules/fast-glob/out/utils/path.js": +/***/ (function(module, exports, __webpack_require__) { - let parts = { negatives: [], positives: [] }; - let push = num => parts[num < 0 ? 'negatives' : 'positives'].push(Math.abs(num)); - let range = []; - let index = 0; +"use strict"; - while (descending ? a >= b : a <= b) { - if (options.toRegex === true && step > 1) { - push(a); - } else { - range.push(pad(format(a, index), maxLen, toNumber)); +Object.defineProperty(exports, "__esModule", { value: true }); +exports.removeLeadingDotSegment = exports.escape = exports.makeAbsolute = exports.unixify = void 0; +const path = __webpack_require__("path"); +const LEADING_DOT_SEGMENT_CHARACTERS_COUNT = 2; // ./ or .\\ +const UNESCAPED_GLOB_SYMBOLS_RE = /(\\?)([()*?[\]{|}]|^!|[!+@](?=\())/g; +/** + * Designed to work only with simple paths: `dir\\file`. + */ +function unixify(filepath) { + return filepath.replace(/\\/g, '/'); +} +exports.unixify = unixify; +function makeAbsolute(cwd, filepath) { + return path.resolve(cwd, filepath); +} +exports.makeAbsolute = makeAbsolute; +function escape(pattern) { + return pattern.replace(UNESCAPED_GLOB_SYMBOLS_RE, '\\$2'); +} +exports.escape = escape; +function removeLeadingDotSegment(entry) { + // We do not use `startsWith` because this is 10x slower than current implementation for some cases. + // eslint-disable-next-line @typescript-eslint/prefer-string-starts-ends-with + if (entry.charAt(0) === '.') { + const secondCharactery = entry.charAt(1); + if (secondCharactery === '/' || secondCharactery === '\\') { + return entry.slice(LEADING_DOT_SEGMENT_CHARACTERS_COUNT); + } } - a = descending ? a - step : a + step; - index++; - } - - if (options.toRegex === true) { - return step > 1 - ? toSequence(parts, options) - : toRegex(range, null, { wrap: false, ...options }); - } - - return range; -}; - -const fillLetters = (start, end, step = 1, options = {}) => { - if ((!isNumber(start) && start.length > 1) || (!isNumber(end) && end.length > 1)) { - return invalidRange(start, end, options); - } - + return entry; +} +exports.removeLeadingDotSegment = removeLeadingDotSegment; - let format = options.transform || (val => String.fromCharCode(val)); - let a = `${start}`.charCodeAt(0); - let b = `${end}`.charCodeAt(0); - let descending = a > b; - let min = Math.min(a, b); - let max = Math.max(a, b); +/***/ }), - if (options.toRegex && step === 1) { - return toRange(min, max, false, options); - } +/***/ "../../node_modules/fast-glob/out/utils/pattern.js": +/***/ (function(module, exports, __webpack_require__) { - let range = []; - let index = 0; +"use strict"; - while (descending ? a >= b : a <= b) { - range.push(format(a, index)); - a = descending ? a - step : a + step; - index++; - } - - if (options.toRegex === true) { - return toRegex(range, null, { wrap: false, options }); - } +Object.defineProperty(exports, "__esModule", { value: true }); +exports.matchAny = exports.convertPatternsToRe = exports.makeRe = exports.getPatternParts = exports.expandBraceExpansion = exports.expandPatternsWithBraceExpansion = exports.isAffectDepthOfReadingPattern = exports.endsWithSlashGlobStar = exports.hasGlobStar = exports.getBaseDirectory = exports.isPatternRelatedToParentDirectory = exports.getPatternsOutsideCurrentDirectory = exports.getPatternsInsideCurrentDirectory = exports.getPositivePatterns = exports.getNegativePatterns = exports.isPositivePattern = exports.isNegativePattern = exports.convertToNegativePattern = exports.convertToPositivePattern = exports.isDynamicPattern = exports.isStaticPattern = void 0; +const path = __webpack_require__("path"); +const globParent = __webpack_require__("../../node_modules/glob-parent/index.js"); +const micromatch = __webpack_require__("../../node_modules/fast-glob/node_modules/micromatch/index.js"); +const GLOBSTAR = '**'; +const ESCAPE_SYMBOL = '\\'; +const COMMON_GLOB_SYMBOLS_RE = /[*?]|^!/; +const REGEX_CHARACTER_CLASS_SYMBOLS_RE = /\[.*]/; +const REGEX_GROUP_SYMBOLS_RE = /(?:^|[^!*+?@])\(.*\|.*\)/; +const GLOB_EXTENSION_SYMBOLS_RE = /[!*+?@]\(.*\)/; +const BRACE_EXPANSIONS_SYMBOLS_RE = /{.*(?:,|\.\.).*}/; +function isStaticPattern(pattern, options = {}) { + return !isDynamicPattern(pattern, options); +} +exports.isStaticPattern = isStaticPattern; +function isDynamicPattern(pattern, options = {}) { + /** + * A special case with an empty string is necessary for matching patterns that start with a forward slash. + * An empty string cannot be a dynamic pattern. + * For example, the pattern `/lib/*` will be spread into parts: '', 'lib', '*'. + */ + if (pattern === '') { + return false; + } + /** + * When the `caseSensitiveMatch` option is disabled, all patterns must be marked as dynamic, because we cannot check + * filepath directly (without read directory). + */ + if (options.caseSensitiveMatch === false || pattern.includes(ESCAPE_SYMBOL)) { + return true; + } + if (COMMON_GLOB_SYMBOLS_RE.test(pattern) || REGEX_CHARACTER_CLASS_SYMBOLS_RE.test(pattern) || REGEX_GROUP_SYMBOLS_RE.test(pattern)) { + return true; + } + if (options.extglob !== false && GLOB_EXTENSION_SYMBOLS_RE.test(pattern)) { + return true; + } + if (options.braceExpansion !== false && BRACE_EXPANSIONS_SYMBOLS_RE.test(pattern)) { + return true; + } + return false; +} +exports.isDynamicPattern = isDynamicPattern; +function convertToPositivePattern(pattern) { + return isNegativePattern(pattern) ? pattern.slice(1) : pattern; +} +exports.convertToPositivePattern = convertToPositivePattern; +function convertToNegativePattern(pattern) { + return '!' + pattern; +} +exports.convertToNegativePattern = convertToNegativePattern; +function isNegativePattern(pattern) { + return pattern.startsWith('!') && pattern[1] !== '('; +} +exports.isNegativePattern = isNegativePattern; +function isPositivePattern(pattern) { + return !isNegativePattern(pattern); +} +exports.isPositivePattern = isPositivePattern; +function getNegativePatterns(patterns) { + return patterns.filter(isNegativePattern); +} +exports.getNegativePatterns = getNegativePatterns; +function getPositivePatterns(patterns) { + return patterns.filter(isPositivePattern); +} +exports.getPositivePatterns = getPositivePatterns; +/** + * Returns patterns that can be applied inside the current directory. + * + * @example + * // ['./*', '*', 'a/*'] + * getPatternsInsideCurrentDirectory(['./*', '*', 'a/*', '../*', './../*']) + */ +function getPatternsInsideCurrentDirectory(patterns) { + return patterns.filter((pattern) => !isPatternRelatedToParentDirectory(pattern)); +} +exports.getPatternsInsideCurrentDirectory = getPatternsInsideCurrentDirectory; +/** + * Returns patterns to be expanded relative to (outside) the current directory. + * + * @example + * // ['../*', './../*'] + * getPatternsInsideCurrentDirectory(['./*', '*', 'a/*', '../*', './../*']) + */ +function getPatternsOutsideCurrentDirectory(patterns) { + return patterns.filter(isPatternRelatedToParentDirectory); +} +exports.getPatternsOutsideCurrentDirectory = getPatternsOutsideCurrentDirectory; +function isPatternRelatedToParentDirectory(pattern) { + return pattern.startsWith('..') || pattern.startsWith('./..'); +} +exports.isPatternRelatedToParentDirectory = isPatternRelatedToParentDirectory; +function getBaseDirectory(pattern) { + return globParent(pattern, { flipBackslashes: false }); +} +exports.getBaseDirectory = getBaseDirectory; +function hasGlobStar(pattern) { + return pattern.includes(GLOBSTAR); +} +exports.hasGlobStar = hasGlobStar; +function endsWithSlashGlobStar(pattern) { + return pattern.endsWith('/' + GLOBSTAR); +} +exports.endsWithSlashGlobStar = endsWithSlashGlobStar; +function isAffectDepthOfReadingPattern(pattern) { + const basename = path.basename(pattern); + return endsWithSlashGlobStar(pattern) || isStaticPattern(basename); +} +exports.isAffectDepthOfReadingPattern = isAffectDepthOfReadingPattern; +function expandPatternsWithBraceExpansion(patterns) { + return patterns.reduce((collection, pattern) => { + return collection.concat(expandBraceExpansion(pattern)); + }, []); +} +exports.expandPatternsWithBraceExpansion = expandPatternsWithBraceExpansion; +function expandBraceExpansion(pattern) { + return micromatch.braces(pattern, { + expand: true, + nodupes: true + }); +} +exports.expandBraceExpansion = expandBraceExpansion; +function getPatternParts(pattern, options) { + let { parts } = micromatch.scan(pattern, Object.assign(Object.assign({}, options), { parts: true })); + /** + * The scan method returns an empty array in some cases. + * See micromatch/picomatch#58 for more details. + */ + if (parts.length === 0) { + parts = [pattern]; + } + /** + * The scan method does not return an empty part for the pattern with a forward slash. + * This is another part of micromatch/picomatch#58. + */ + if (parts[0].startsWith('/')) { + parts[0] = parts[0].slice(1); + parts.unshift(''); + } + return parts; +} +exports.getPatternParts = getPatternParts; +function makeRe(pattern, options) { + return micromatch.makeRe(pattern, options); +} +exports.makeRe = makeRe; +function convertPatternsToRe(patterns, options) { + return patterns.map((pattern) => makeRe(pattern, options)); +} +exports.convertPatternsToRe = convertPatternsToRe; +function matchAny(entry, patternsRe) { + return patternsRe.some((patternRe) => patternRe.test(entry)); +} +exports.matchAny = matchAny; - return range; -}; -const fill = (start, end, step, options = {}) => { - if (end == null && isValidValue(start)) { - return [start]; - } +/***/ }), - if (!isValidValue(start) || !isValidValue(end)) { - return invalidRange(start, end, options); - } +/***/ "../../node_modules/fast-glob/out/utils/stream.js": +/***/ (function(module, exports, __webpack_require__) { - if (typeof step === 'function') { - return fill(start, end, 1, { transform: step }); - } +"use strict"; - if (isObject(step)) { - return fill(start, end, 0, step); - } +Object.defineProperty(exports, "__esModule", { value: true }); +exports.merge = void 0; +const merge2 = __webpack_require__("../../node_modules/merge2/index.js"); +function merge(streams) { + const mergedStream = merge2(streams); + streams.forEach((stream) => { + stream.once('error', (error) => mergedStream.emit('error', error)); + }); + mergedStream.once('close', () => propagateCloseEventToSources(streams)); + mergedStream.once('end', () => propagateCloseEventToSources(streams)); + return mergedStream; +} +exports.merge = merge; +function propagateCloseEventToSources(streams) { + streams.forEach((stream) => stream.emit('close')); +} - let opts = { ...options }; - if (opts.capture === true) opts.wrap = true; - step = step || opts.step || 1; - if (!isNumber(step)) { - if (step != null && !isObject(step)) return invalidStep(step, opts); - return fill(start, end, 1, step); - } +/***/ }), - if (isNumber(start) && isNumber(end)) { - return fillNumbers(start, end, step, opts); - } +/***/ "../../node_modules/fast-glob/out/utils/string.js": +/***/ (function(module, exports, __webpack_require__) { - return fillLetters(start, end, Math.max(Math.abs(step), 1), opts); -}; +"use strict"; -module.exports = fill; +Object.defineProperty(exports, "__esModule", { value: true }); +exports.isEmpty = exports.isString = void 0; +function isString(input) { + return typeof input === 'string'; +} +exports.isString = isString; +function isEmpty(input) { + return input === ''; +} +exports.isEmpty = isEmpty; /***/ }), -/***/ "../../node_modules/follow-redirects/debug.js": +/***/ "../../node_modules/fastq/queue.js": /***/ (function(module, exports, __webpack_require__) { -var debug; +"use strict"; -module.exports = function () { - if (!debug) { - try { - /* eslint global-require: off */ - debug = __webpack_require__("../../node_modules/debug/src/index.js")("follow-redirects"); - } - catch (error) { /* */ } - if (typeof debug !== "function") { - debug = function () { /* */ }; - } - } - debug.apply(null, arguments); -}; +var reusify = __webpack_require__("../../node_modules/reusify/reusify.js") -/***/ }), +function fastqueue (context, worker, concurrency) { + if (typeof context === 'function') { + concurrency = worker + worker = context + context = null + } -/***/ "../../node_modules/follow-redirects/index.js": -/***/ (function(module, exports, __webpack_require__) { + var cache = reusify(Task) + var queueHead = null + var queueTail = null + var _running = 0 -var url = __webpack_require__("url"); -var URL = url.URL; -var http = __webpack_require__("http"); -var https = __webpack_require__("https"); -var Writable = __webpack_require__("stream").Writable; -var assert = __webpack_require__("assert"); -var debug = __webpack_require__("../../node_modules/follow-redirects/debug.js"); - -// Create handlers that pass events from native requests -var events = ["abort", "aborted", "connect", "error", "socket", "timeout"]; -var eventHandlers = Object.create(null); -events.forEach(function (event) { - eventHandlers[event] = function (arg1, arg2, arg3) { - this._redirectable.emit(event, arg1, arg2, arg3); - }; -}); - -// Error types with codes -var RedirectionError = createErrorType( - "ERR_FR_REDIRECTION_FAILURE", - "Redirected request failed" -); -var TooManyRedirectsError = createErrorType( - "ERR_FR_TOO_MANY_REDIRECTS", - "Maximum number of redirects exceeded" -); -var MaxBodyLengthExceededError = createErrorType( - "ERR_FR_MAX_BODY_LENGTH_EXCEEDED", - "Request body larger than maxBodyLength limit" -); -var WriteAfterEndError = createErrorType( - "ERR_STREAM_WRITE_AFTER_END", - "write after end" -); + var self = { + push: push, + drain: noop, + saturated: noop, + pause: pause, + paused: false, + concurrency: concurrency, + running: running, + resume: resume, + idle: idle, + length: length, + unshift: unshift, + empty: noop, + kill: kill, + killAndDrain: killAndDrain + } -// An HTTP(S) request that can be redirected -function RedirectableRequest(options, responseCallback) { - // Initialize the request - Writable.call(this); - this._sanitizeOptions(options); - this._options = options; - this._ended = false; - this._ending = false; - this._redirectCount = 0; - this._redirects = []; - this._requestBodyLength = 0; - this._requestBodyBuffers = []; + return self - // Attach a callback if passed - if (responseCallback) { - this.on("response", responseCallback); + function running () { + return _running } - // React to responses of native requests - var self = this; - this._onNativeResponse = function (response) { - self._processResponse(response); - }; - - // Perform the first request - this._performRequest(); -} -RedirectableRequest.prototype = Object.create(Writable.prototype); + function pause () { + self.paused = true + } -RedirectableRequest.prototype.abort = function () { - abortRequest(this._currentRequest); - this.emit("abort"); -}; + function length () { + var current = queueHead + var counter = 0 -// Writes buffered data to the current native request -RedirectableRequest.prototype.write = function (data, encoding, callback) { - // Writing is not allowed if end has been called - if (this._ending) { - throw new WriteAfterEndError(); - } + while (current) { + current = current.next + counter++ + } - // Validate input and shift parameters if necessary - if (!(typeof data === "string" || typeof data === "object" && ("length" in data))) { - throw new TypeError("data should be a string, Buffer or Uint8Array"); - } - if (typeof encoding === "function") { - callback = encoding; - encoding = null; + return counter } - // Ignore empty buffers, since writing them doesn't invoke the callback - // https://github.com/nodejs/node/issues/22066 - if (data.length === 0) { - if (callback) { - callback(); + function resume () { + if (!self.paused) return + self.paused = false + for (var i = 0; i < self.concurrency; i++) { + _running++ + release() } - return; - } - // Only write when we don't exceed the maximum body length - if (this._requestBodyLength + data.length <= this._options.maxBodyLength) { - this._requestBodyLength += data.length; - this._requestBodyBuffers.push({ data: data, encoding: encoding }); - this._currentRequest.write(data, encoding, callback); - } - // Error when we exceed the maximum body length - else { - this.emit("error", new MaxBodyLengthExceededError()); - this.abort(); } -}; -// Ends the current native request -RedirectableRequest.prototype.end = function (data, encoding, callback) { - // Shift parameters if necessary - if (typeof data === "function") { - callback = data; - data = encoding = null; - } - else if (typeof encoding === "function") { - callback = encoding; - encoding = null; + function idle () { + return _running === 0 && self.length() === 0 } - // Write data if needed and end - if (!data) { - this._ended = this._ending = true; - this._currentRequest.end(null, null, callback); - } - else { - var self = this; - var currentRequest = this._currentRequest; - this.write(data, encoding, function () { - self._ended = true; - currentRequest.end(null, null, callback); - }); - this._ending = true; - } -}; + function push (value, done) { + var current = cache.get() -// Sets a header value on the current native request -RedirectableRequest.prototype.setHeader = function (name, value) { - this._options.headers[name] = value; - this._currentRequest.setHeader(name, value); -}; + current.context = context + current.release = release + current.value = value + current.callback = done || noop -// Clears a header value on the current native request -RedirectableRequest.prototype.removeHeader = function (name) { - delete this._options.headers[name]; - this._currentRequest.removeHeader(name); -}; + if (_running === self.concurrency || self.paused) { + if (queueTail) { + queueTail.next = current + queueTail = current + } else { + queueHead = current + queueTail = current + self.saturated() + } + } else { + _running++ + worker.call(context, current.value, current.worked) + } + } -// Global timeout for all underlying requests -RedirectableRequest.prototype.setTimeout = function (msecs, callback) { - var self = this; + function unshift (value, done) { + var current = cache.get() - // Destroys the socket on timeout - function destroyOnTimeout(socket) { - socket.setTimeout(msecs); - socket.removeListener("timeout", socket.destroy); - socket.addListener("timeout", socket.destroy); - } + current.context = context + current.release = release + current.value = value + current.callback = done || noop - // Sets up a timer to trigger a timeout event - function startTimer(socket) { - if (self._timeout) { - clearTimeout(self._timeout); + if (_running === self.concurrency || self.paused) { + if (queueHead) { + current.next = queueHead + queueHead = current + } else { + queueHead = current + queueTail = current + self.saturated() + } + } else { + _running++ + worker.call(context, current.value, current.worked) } - self._timeout = setTimeout(function () { - self.emit("timeout"); - clearTimer(); - }, msecs); - destroyOnTimeout(socket); } - // Stops a timeout from triggering - function clearTimer() { - // Clear the timeout - if (self._timeout) { - clearTimeout(self._timeout); - self._timeout = null; + function release (holder) { + if (holder) { + cache.release(holder) } - - // Clean up all attached listeners - self.removeListener("abort", clearTimer); - self.removeListener("error", clearTimer); - self.removeListener("response", clearTimer); - if (callback) { - self.removeListener("timeout", callback); - } - if (!self.socket) { - self._currentRequest.removeListener("socket", startTimer); + var next = queueHead + if (next) { + if (!self.paused) { + if (queueTail === queueHead) { + queueTail = null + } + queueHead = next.next + next.next = null + worker.call(context, next.value, next.worked) + if (queueTail === null) { + self.empty() + } + } else { + _running-- + } + } else if (--_running === 0) { + self.drain() } } - // Attach callback if passed - if (callback) { - this.on("timeout", callback); + function kill () { + queueHead = null + queueTail = null + self.drain = noop } - // Start the timer if or when the socket is opened - if (this.socket) { - startTimer(this.socket); + function killAndDrain () { + queueHead = null + queueTail = null + self.drain() + self.drain = noop } - else { - this._currentRequest.once("socket", startTimer); +} + +function noop () {} + +function Task () { + this.value = null + this.callback = noop + this.next = null + this.release = noop + this.context = null + + var self = this + + this.worked = function worked (err, result) { + var callback = self.callback + self.value = null + self.callback = noop + callback.call(self.context, err, result) + self.release(self) } +} - // Clean up on events - this.on("socket", destroyOnTimeout); - this.on("abort", clearTimer); - this.on("error", clearTimer); - this.on("response", clearTimer); +module.exports = fastqueue - return this; + +/***/ }), + +/***/ "../../node_modules/fill-range/index.js": +/***/ (function(module, exports, __webpack_require__) { + +"use strict"; +/*! + * fill-range + * + * Copyright (c) 2014-present, Jon Schlinkert. + * Licensed under the MIT License. + */ + + + +const util = __webpack_require__("util"); +const toRegexRange = __webpack_require__("../../node_modules/to-regex-range/index.js"); + +const isObject = val => val !== null && typeof val === 'object' && !Array.isArray(val); + +const transform = toNumber => { + return value => toNumber === true ? Number(value) : String(value); }; -// Proxy all other public ClientRequest methods -[ - "flushHeaders", "getHeader", - "setNoDelay", "setSocketKeepAlive", -].forEach(function (method) { - RedirectableRequest.prototype[method] = function (a, b) { - return this._currentRequest[method](a, b); - }; -}); +const isValidValue = value => { + return typeof value === 'number' || (typeof value === 'string' && value !== ''); +}; -// Proxy all public ClientRequest properties -["aborted", "connection", "socket"].forEach(function (property) { - Object.defineProperty(RedirectableRequest.prototype, property, { - get: function () { return this._currentRequest[property]; }, - }); -}); +const isNumber = num => Number.isInteger(+num); -RedirectableRequest.prototype._sanitizeOptions = function (options) { - // Ensure headers are always present - if (!options.headers) { - options.headers = {}; +const zeros = input => { + let value = `${input}`; + let index = -1; + if (value[0] === '-') value = value.slice(1); + if (value === '0') return false; + while (value[++index] === '0'); + return index > 0; +}; + +const stringify = (start, end, options) => { + if (typeof start === 'string' || typeof end === 'string') { + return true; } + return options.stringify === true; +}; - // Since http.request treats host as an alias of hostname, - // but the url module interprets host as hostname plus port, - // eliminate the host property to avoid confusion. - if (options.host) { - // Use hostname if set, because it has precedence - if (!options.hostname) { - options.hostname = options.host; - } - delete options.host; +const pad = (input, maxLength, toNumber) => { + if (maxLength > 0) { + let dash = input[0] === '-' ? '-' : ''; + if (dash) input = input.slice(1); + input = (dash + input.padStart(dash ? maxLength - 1 : maxLength, '0')); } + if (toNumber === false) { + return String(input); + } + return input; +}; - // Complete the URL object when necessary - if (!options.pathname && options.path) { - var searchPos = options.path.indexOf("?"); - if (searchPos < 0) { - options.pathname = options.path; - } - else { - options.pathname = options.path.substring(0, searchPos); - options.search = options.path.substring(searchPos); - } +const toMaxLen = (input, maxLength) => { + let negative = input[0] === '-' ? '-' : ''; + if (negative) { + input = input.slice(1); + maxLength--; } + while (input.length < maxLength) input = '0' + input; + return negative ? ('-' + input) : input; }; +const toSequence = (parts, options) => { + parts.negatives.sort((a, b) => a < b ? -1 : a > b ? 1 : 0); + parts.positives.sort((a, b) => a < b ? -1 : a > b ? 1 : 0); -// Executes the next native request (initial or redirect) -RedirectableRequest.prototype._performRequest = function () { - // Load the native protocol - var protocol = this._options.protocol; - var nativeProtocol = this._options.nativeProtocols[protocol]; - if (!nativeProtocol) { - this.emit("error", new TypeError("Unsupported protocol " + protocol)); - return; - } + let prefix = options.capture ? '' : '?:'; + let positives = ''; + let negatives = ''; + let result; - // If specified, use the agent corresponding to the protocol - // (HTTP and HTTPS use different types of agents) - if (this._options.agents) { - var scheme = protocol.slice(0, -1); - this._options.agent = this._options.agents[scheme]; + if (parts.positives.length) { + positives = parts.positives.join('|'); } - // Create the native request - var request = this._currentRequest = - nativeProtocol.request(this._options, this._onNativeResponse); - this._currentUrl = url.format(this._options); + if (parts.negatives.length) { + negatives = `-(${prefix}${parts.negatives.join('|')})`; + } - // Set up event handlers - request._redirectable = this; - for (var e = 0; e < events.length; e++) { - request.on(events[e], eventHandlers[events[e]]); + if (positives && negatives) { + result = `${positives}|${negatives}`; + } else { + result = positives || negatives; } - // End a redirected request - // (The first request must be ended explicitly with RedirectableRequest#end) - if (this._isRedirect) { - // Write the request entity and end. - var i = 0; - var self = this; - var buffers = this._requestBodyBuffers; - (function writeNext(error) { - // Only write if this request has not been redirected yet - /* istanbul ignore else */ - if (request === self._currentRequest) { - // Report any write errors - /* istanbul ignore if */ - if (error) { - self.emit("error", error); - } - // Write the next buffer if there are still left - else if (i < buffers.length) { - var buffer = buffers[i++]; - /* istanbul ignore else */ - if (!request.finished) { - request.write(buffer.data, buffer.encoding, writeNext); - } - } - // End the request if `end` has been called on us - else if (self._ended) { - request.end(); - } - } - }()); + if (options.wrap) { + return `(${prefix}${result})`; } + + return result; }; -// Processes a response from the current native request -RedirectableRequest.prototype._processResponse = function (response) { - // Store the redirected response - var statusCode = response.statusCode; - if (this._options.trackRedirects) { - this._redirects.push({ - url: this._currentUrl, - headers: response.headers, - statusCode: statusCode, - }); +const toRange = (a, b, isNumbers, options) => { + if (isNumbers) { + return toRegexRange(a, b, { wrap: false, ...options }); } - // RFC7231§6.4: The 3xx (Redirection) class of status code indicates - // that further action needs to be taken by the user agent in order to - // fulfill the request. If a Location header field is provided, - // the user agent MAY automatically redirect its request to the URI - // referenced by the Location field value, - // even if the specific status code is not understood. + let start = String.fromCharCode(a); + if (a === b) return start; - // If the response is not a redirect; return it as-is - var location = response.headers.location; - if (!location || this._options.followRedirects === false || - statusCode < 300 || statusCode >= 400) { - response.responseUrl = this._currentUrl; - response.redirects = this._redirects; - this.emit("response", response); + let stop = String.fromCharCode(b); + return `[${start}-${stop}]`; +}; - // Clean up - this._requestBodyBuffers = []; - return; +const toRegex = (start, end, options) => { + if (Array.isArray(start)) { + let wrap = options.wrap === true; + let prefix = options.capture ? '' : '?:'; + return wrap ? `(${prefix}${start.join('|')})` : start.join('|'); } + return toRegexRange(start, end, options); +}; - // The response is a redirect, so abort the current request - abortRequest(this._currentRequest); - // Discard the remainder of the response to avoid waiting for data - response.destroy(); +const rangeError = (...args) => { + return new RangeError('Invalid range arguments: ' + util.inspect(...args)); +}; - // RFC7231§6.4: A client SHOULD detect and intervene - // in cyclical redirections (i.e., "infinite" redirection loops). - if (++this._redirectCount > this._options.maxRedirects) { - this.emit("error", new TooManyRedirectsError()); - return; - } +const invalidRange = (start, end, options) => { + if (options.strictRanges === true) throw rangeError([start, end]); + return []; +}; - // Store the request headers if applicable - var requestHeaders; - var beforeRedirect = this._options.beforeRedirect; - if (beforeRedirect) { - requestHeaders = Object.assign({ - // The Host header was set by nativeProtocol.request - Host: response.req.getHeader("host"), - }, this._options.headers); +const invalidStep = (step, options) => { + if (options.strictRanges === true) { + throw new TypeError(`Expected step "${step}" to be a number`); } + return []; +}; - // RFC7231§6.4: Automatic redirection needs to done with - // care for methods not known to be safe, […] - // RFC7231§6.4.2–3: For historical reasons, a user agent MAY change - // the request method from POST to GET for the subsequent request. - var method = this._options.method; - if ((statusCode === 301 || statusCode === 302) && this._options.method === "POST" || - // RFC7231§6.4.4: The 303 (See Other) status code indicates that - // the server is redirecting the user agent to a different resource […] - // A user agent can perform a retrieval request targeting that URI - // (a GET or HEAD request if using HTTP) […] - (statusCode === 303) && !/^(?:GET|HEAD)$/.test(this._options.method)) { - this._options.method = "GET"; - // Drop a possible entity and headers related to it - this._requestBodyBuffers = []; - removeMatchingHeaders(/^content-/i, this._options.headers); - } +const fillNumbers = (start, end, step = 1, options = {}) => { + let a = Number(start); + let b = Number(end); - // Drop the Host header, as the redirect might lead to a different host - var currentHostHeader = removeMatchingHeaders(/^host$/i, this._options.headers); + if (!Number.isInteger(a) || !Number.isInteger(b)) { + if (options.strictRanges === true) throw rangeError([start, end]); + return []; + } - // If the redirect is relative, carry over the host of the last request - var currentUrlParts = url.parse(this._currentUrl); - var currentHost = currentHostHeader || currentUrlParts.host; - var currentUrl = /^\w+:/.test(location) ? this._currentUrl : - url.format(Object.assign(currentUrlParts, { host: currentHost })); + // fix negative zero + if (a === 0) a = 0; + if (b === 0) b = 0; - // Determine the URL of the redirection - var redirectUrl; - try { - redirectUrl = url.resolve(currentUrl, location); - } - catch (cause) { - this.emit("error", new RedirectionError(cause)); - return; - } + let descending = a > b; + let startString = String(start); + let endString = String(end); + let stepString = String(step); + step = Math.max(Math.abs(step), 1); - // Create the redirected request - debug("redirecting to", redirectUrl); - this._isRedirect = true; - var redirectUrlParts = url.parse(redirectUrl); - Object.assign(this._options, redirectUrlParts); + let padded = zeros(startString) || zeros(endString) || zeros(stepString); + let maxLen = padded ? Math.max(startString.length, endString.length, stepString.length) : 0; + let toNumber = padded === false && stringify(start, end, options) === false; + let format = options.transform || transform(toNumber); - // Drop confidential headers when redirecting to a less secure protocol - // or to a different domain that is not a superdomain - if (redirectUrlParts.protocol !== currentUrlParts.protocol && - redirectUrlParts.protocol !== "https:" || - redirectUrlParts.host !== currentHost && - !isSubdomain(redirectUrlParts.host, currentHost)) { - removeMatchingHeaders(/^(?:authorization|cookie)$/i, this._options.headers); + if (options.toRegex && step === 1) { + return toRange(toMaxLen(start, maxLen), toMaxLen(end, maxLen), true, options); } - // Evaluate the beforeRedirect callback - if (typeof beforeRedirect === "function") { - var responseDetails = { - headers: response.headers, - statusCode: statusCode, - }; - var requestDetails = { - url: currentUrl, - method: method, - headers: requestHeaders, - }; - try { - beforeRedirect(this._options, responseDetails, requestDetails); - } - catch (err) { - this.emit("error", err); - return; + let parts = { negatives: [], positives: [] }; + let push = num => parts[num < 0 ? 'negatives' : 'positives'].push(Math.abs(num)); + let range = []; + let index = 0; + + while (descending ? a >= b : a <= b) { + if (options.toRegex === true && step > 1) { + push(a); + } else { + range.push(pad(format(a, index), maxLen, toNumber)); } - this._sanitizeOptions(this._options); + a = descending ? a - step : a + step; + index++; } - // Perform the redirected request - try { - this._performRequest(); - } - catch (cause) { - this.emit("error", new RedirectionError(cause)); + if (options.toRegex === true) { + return step > 1 + ? toSequence(parts, options) + : toRegex(range, null, { wrap: false, ...options }); } + + return range; }; -// Wraps the key/value object of protocols with redirect functionality -function wrap(protocols) { - // Default settings - var exports = { - maxRedirects: 21, - maxBodyLength: 10 * 1024 * 1024, - }; +const fillLetters = (start, end, step = 1, options = {}) => { + if ((!isNumber(start) && start.length > 1) || (!isNumber(end) && end.length > 1)) { + return invalidRange(start, end, options); + } - // Wrap each protocol - var nativeProtocols = {}; - Object.keys(protocols).forEach(function (scheme) { - var protocol = scheme + ":"; - var nativeProtocol = nativeProtocols[protocol] = protocols[scheme]; - var wrappedProtocol = exports[scheme] = Object.create(nativeProtocol); - // Executes a request, following redirects - function request(input, options, callback) { - // Parse parameters - if (typeof input === "string") { - var urlStr = input; - try { - input = urlToOptions(new URL(urlStr)); - } - catch (err) { - /* istanbul ignore next */ - input = url.parse(urlStr); - } - } - else if (URL && (input instanceof URL)) { - input = urlToOptions(input); - } - else { - callback = options; - options = input; - input = { protocol: protocol }; - } - if (typeof options === "function") { - callback = options; - options = null; - } + let format = options.transform || (val => String.fromCharCode(val)); + let a = `${start}`.charCodeAt(0); + let b = `${end}`.charCodeAt(0); - // Set defaults - options = Object.assign({ - maxRedirects: exports.maxRedirects, - maxBodyLength: exports.maxBodyLength, - }, input, options); - options.nativeProtocols = nativeProtocols; + let descending = a > b; + let min = Math.min(a, b); + let max = Math.max(a, b); - assert.equal(options.protocol, protocol, "protocol mismatch"); - debug("options", options); - return new RedirectableRequest(options, callback); - } + if (options.toRegex && step === 1) { + return toRange(min, max, false, options); + } - // Executes a GET request, following redirects - function get(input, options, callback) { - var wrappedRequest = wrappedProtocol.request(input, options, callback); - wrappedRequest.end(); - return wrappedRequest; - } + let range = []; + let index = 0; - // Expose the properties on the wrapped protocol - Object.defineProperties(wrappedProtocol, { - request: { value: request, configurable: true, enumerable: true, writable: true }, - get: { value: get, configurable: true, enumerable: true, writable: true }, - }); - }); - return exports; -} + while (descending ? a >= b : a <= b) { + range.push(format(a, index)); + a = descending ? a - step : a + step; + index++; + } -/* istanbul ignore next */ -function noop() { /* empty */ } + if (options.toRegex === true) { + return toRegex(range, null, { wrap: false, options }); + } -// from https://github.com/nodejs/node/blob/master/lib/internal/url.js -function urlToOptions(urlObject) { - var options = { - protocol: urlObject.protocol, - hostname: urlObject.hostname.startsWith("[") ? - /* istanbul ignore next */ - urlObject.hostname.slice(1, -1) : - urlObject.hostname, - hash: urlObject.hash, - search: urlObject.search, - pathname: urlObject.pathname, - path: urlObject.pathname + urlObject.search, - href: urlObject.href, - }; - if (urlObject.port !== "") { - options.port = Number(urlObject.port); + return range; +}; + +const fill = (start, end, step, options = {}) => { + if (end == null && isValidValue(start)) { + return [start]; } - return options; -} -function removeMatchingHeaders(regex, headers) { - var lastValue; - for (var header in headers) { - if (regex.test(header)) { - lastValue = headers[header]; - delete headers[header]; - } + if (!isValidValue(start) || !isValidValue(end)) { + return invalidRange(start, end, options); } - return (lastValue === null || typeof lastValue === "undefined") ? - undefined : String(lastValue).trim(); -} -function createErrorType(code, defaultMessage) { - function CustomError(cause) { - Error.captureStackTrace(this, this.constructor); - if (!cause) { - this.message = defaultMessage; - } - else { - this.message = defaultMessage + ": " + cause.message; - this.cause = cause; - } + if (typeof step === 'function') { + return fill(start, end, 1, { transform: step }); } - CustomError.prototype = new Error(); - CustomError.prototype.constructor = CustomError; - CustomError.prototype.name = "Error [" + code + "]"; - CustomError.prototype.code = code; - return CustomError; -} -function abortRequest(request) { - for (var e = 0; e < events.length; e++) { - request.removeListener(events[e], eventHandlers[events[e]]); + if (isObject(step)) { + return fill(start, end, 0, step); } - request.on("error", noop); - request.abort(); -} - -function isSubdomain(subdomain, domain) { - const dot = subdomain.length - domain.length - 1; - return dot > 0 && subdomain[dot] === "." && subdomain.endsWith(domain); -} - -// Exports -module.exports = wrap({ http: http, https: https }); -module.exports.wrap = wrap; + let opts = { ...options }; + if (opts.capture === true) opts.wrap = true; + step = step || opts.step || 1; -/***/ }), + if (!isNumber(step)) { + if (step != null && !isObject(step)) return invalidStep(step, opts); + return fill(start, end, 1, step); + } -/***/ "../../node_modules/form-data/lib/form_data.js": -/***/ (function(module, exports, __webpack_require__) { + if (isNumber(start) && isNumber(end)) { + return fillNumbers(start, end, step, opts); + } -var CombinedStream = __webpack_require__("../../node_modules/combined-stream/lib/combined_stream.js"); -var util = __webpack_require__("util"); -var path = __webpack_require__("path"); -var http = __webpack_require__("http"); -var https = __webpack_require__("https"); -var parseUrl = __webpack_require__("url").parse; -var fs = __webpack_require__("fs"); -var Stream = __webpack_require__("stream").Stream; -var mime = __webpack_require__("../../node_modules/mime-types/index.js"); -var asynckit = __webpack_require__("../../node_modules/asynckit/index.js"); -var populate = __webpack_require__("../../node_modules/form-data/lib/populate.js"); + return fillLetters(start, end, Math.max(Math.abs(step), 1), opts); +}; -// Public API -module.exports = FormData; +module.exports = fill; -// make it a Stream -util.inherits(FormData, CombinedStream); -/** - * Create readable "multipart/form-data" streams. - * Can be used to submit forms - * and file uploads to other web applications. - * - * @constructor - * @param {Object} options - Properties to be added/overriden for FormData and CombinedStream - */ -function FormData(options) { - if (!(this instanceof FormData)) { - return new FormData(options); - } +/***/ }), - this._overheadLength = 0; - this._valueLength = 0; - this._valuesToMeasure = []; +/***/ "../../node_modules/follow-redirects/debug.js": +/***/ (function(module, exports, __webpack_require__) { - CombinedStream.call(this); +var debug; - options = options || {}; - for (var option in options) { - this[option] = options[option]; +module.exports = function () { + if (!debug) { + try { + /* eslint global-require: off */ + debug = __webpack_require__("../../node_modules/debug/src/index.js")("follow-redirects"); + } + catch (error) { /* */ } + if (typeof debug !== "function") { + debug = function () { /* */ }; + } } -} + debug.apply(null, arguments); +}; -FormData.LINE_BREAK = '\r\n'; -FormData.DEFAULT_CONTENT_TYPE = 'application/octet-stream'; -FormData.prototype.append = function(field, value, options) { +/***/ }), - options = options || {}; +/***/ "../../node_modules/follow-redirects/index.js": +/***/ (function(module, exports, __webpack_require__) { - // allow filename as single option - if (typeof options == 'string') { - options = {filename: options}; - } +var url = __webpack_require__("url"); +var URL = url.URL; +var http = __webpack_require__("http"); +var https = __webpack_require__("https"); +var Writable = __webpack_require__("stream").Writable; +var assert = __webpack_require__("assert"); +var debug = __webpack_require__("../../node_modules/follow-redirects/debug.js"); - var append = CombinedStream.prototype.append.bind(this); +// Create handlers that pass events from native requests +var events = ["abort", "aborted", "connect", "error", "socket", "timeout"]; +var eventHandlers = Object.create(null); +events.forEach(function (event) { + eventHandlers[event] = function (arg1, arg2, arg3) { + this._redirectable.emit(event, arg1, arg2, arg3); + }; +}); - // all that streamy business can't handle numbers - if (typeof value == 'number') { - value = '' + value; - } +// Error types with codes +var RedirectionError = createErrorType( + "ERR_FR_REDIRECTION_FAILURE", + "Redirected request failed" +); +var TooManyRedirectsError = createErrorType( + "ERR_FR_TOO_MANY_REDIRECTS", + "Maximum number of redirects exceeded" +); +var MaxBodyLengthExceededError = createErrorType( + "ERR_FR_MAX_BODY_LENGTH_EXCEEDED", + "Request body larger than maxBodyLength limit" +); +var WriteAfterEndError = createErrorType( + "ERR_STREAM_WRITE_AFTER_END", + "write after end" +); - // https://github.com/felixge/node-form-data/issues/38 - if (util.isArray(value)) { - // Please convert your array into string - // the way web server expects it - this._error(new Error('Arrays are not supported.')); - return; +// An HTTP(S) request that can be redirected +function RedirectableRequest(options, responseCallback) { + // Initialize the request + Writable.call(this); + this._sanitizeOptions(options); + this._options = options; + this._ended = false; + this._ending = false; + this._redirectCount = 0; + this._redirects = []; + this._requestBodyLength = 0; + this._requestBodyBuffers = []; + + // Attach a callback if passed + if (responseCallback) { + this.on("response", responseCallback); } - var header = this._multiPartHeader(field, value, options); - var footer = this._multiPartFooter(); + // React to responses of native requests + var self = this; + this._onNativeResponse = function (response) { + self._processResponse(response); + }; - append(header); - append(value); - append(footer); + // Perform the first request + this._performRequest(); +} +RedirectableRequest.prototype = Object.create(Writable.prototype); - // pass along options.knownLength - this._trackLength(header, value, options); +RedirectableRequest.prototype.abort = function () { + abortRequest(this._currentRequest); + this.emit("abort"); }; -FormData.prototype._trackLength = function(header, value, options) { - var valueLength = 0; - - // used w/ getLengthSync(), when length is known. - // e.g. for streaming directly from a remote server, - // w/ a known file a size, and not wanting to wait for - // incoming file to finish to get its size. - if (options.knownLength != null) { - valueLength += +options.knownLength; - } else if (Buffer.isBuffer(value)) { - valueLength = value.length; - } else if (typeof value === 'string') { - valueLength = Buffer.byteLength(value); +// Writes buffered data to the current native request +RedirectableRequest.prototype.write = function (data, encoding, callback) { + // Writing is not allowed if end has been called + if (this._ending) { + throw new WriteAfterEndError(); } - this._valueLength += valueLength; - - // @check why add CRLF? does this account for custom/multiple CRLFs? - this._overheadLength += - Buffer.byteLength(header) + - FormData.LINE_BREAK.length; + // Validate input and shift parameters if necessary + if (!(typeof data === "string" || typeof data === "object" && ("length" in data))) { + throw new TypeError("data should be a string, Buffer or Uint8Array"); + } + if (typeof encoding === "function") { + callback = encoding; + encoding = null; + } - // empty or either doesn't have path or not an http response or not a stream - if (!value || ( !value.path && !(value.readable && value.hasOwnProperty('httpVersion')) && !(value instanceof Stream))) { + // Ignore empty buffers, since writing them doesn't invoke the callback + // https://github.com/nodejs/node/issues/22066 + if (data.length === 0) { + if (callback) { + callback(); + } return; } - - // no need to bother with the length - if (!options.knownLength) { - this._valuesToMeasure.push(value); + // Only write when we don't exceed the maximum body length + if (this._requestBodyLength + data.length <= this._options.maxBodyLength) { + this._requestBodyLength += data.length; + this._requestBodyBuffers.push({ data: data, encoding: encoding }); + this._currentRequest.write(data, encoding, callback); + } + // Error when we exceed the maximum body length + else { + this.emit("error", new MaxBodyLengthExceededError()); + this.abort(); } }; -FormData.prototype._lengthRetriever = function(value, callback) { - - if (value.hasOwnProperty('fd')) { - - // take read range into a account - // `end` = Infinity –> read file till the end - // - // TODO: Looks like there is bug in Node fs.createReadStream - // it doesn't respect `end` options without `start` options - // Fix it when node fixes it. - // https://github.com/joyent/node/issues/7819 - if (value.end != undefined && value.end != Infinity && value.start != undefined) { - - // when end specified - // no need to calculate range - // inclusive, starts with 0 - callback(null, value.end + 1 - (value.start ? value.start : 0)); - - // not that fast snoopy - } else { - // still need to fetch file size from fs - fs.stat(value.path, function(err, stat) { - - var fileSize; - - if (err) { - callback(err); - return; - } - - // update final size based on the range options - fileSize = stat.size - (value.start ? value.start : 0); - callback(null, fileSize); - }); - } - - // or http response - } else if (value.hasOwnProperty('httpVersion')) { - callback(null, +value.headers['content-length']); +// Ends the current native request +RedirectableRequest.prototype.end = function (data, encoding, callback) { + // Shift parameters if necessary + if (typeof data === "function") { + callback = data; + data = encoding = null; + } + else if (typeof encoding === "function") { + callback = encoding; + encoding = null; + } - // or request stream http://github.com/mikeal/request - } else if (value.hasOwnProperty('httpModule')) { - // wait till response come back - value.on('response', function(response) { - value.pause(); - callback(null, +response.headers['content-length']); + // Write data if needed and end + if (!data) { + this._ended = this._ending = true; + this._currentRequest.end(null, null, callback); + } + else { + var self = this; + var currentRequest = this._currentRequest; + this.write(data, encoding, function () { + self._ended = true; + currentRequest.end(null, null, callback); }); - value.resume(); - - // something else - } else { - callback('Unknown stream'); + this._ending = true; } }; -FormData.prototype._multiPartHeader = function(field, value, options) { - // custom header specified (as string)? - // it becomes responsible for boundary - // (e.g. to handle extra CRLFs on .NET servers) - if (typeof options.header == 'string') { - return options.header; - } +// Sets a header value on the current native request +RedirectableRequest.prototype.setHeader = function (name, value) { + this._options.headers[name] = value; + this._currentRequest.setHeader(name, value); +}; - var contentDisposition = this._getContentDisposition(value, options); - var contentType = this._getContentType(value, options); +// Clears a header value on the current native request +RedirectableRequest.prototype.removeHeader = function (name) { + delete this._options.headers[name]; + this._currentRequest.removeHeader(name); +}; - var contents = ''; - var headers = { - // add custom disposition as third element or keep it two elements if not - 'Content-Disposition': ['form-data', 'name="' + field + '"'].concat(contentDisposition || []), - // if no content type. allow it to be empty array - 'Content-Type': [].concat(contentType || []) - }; +// Global timeout for all underlying requests +RedirectableRequest.prototype.setTimeout = function (msecs, callback) { + var self = this; - // allow custom headers. - if (typeof options.header == 'object') { - populate(headers, options.header); + // Destroys the socket on timeout + function destroyOnTimeout(socket) { + socket.setTimeout(msecs); + socket.removeListener("timeout", socket.destroy); + socket.addListener("timeout", socket.destroy); } - var header; - for (var prop in headers) { - if (!headers.hasOwnProperty(prop)) continue; - header = headers[prop]; - - // skip nullish headers. - if (header == null) { - continue; + // Sets up a timer to trigger a timeout event + function startTimer(socket) { + if (self._timeout) { + clearTimeout(self._timeout); } + self._timeout = setTimeout(function () { + self.emit("timeout"); + clearTimer(); + }, msecs); + destroyOnTimeout(socket); + } - // convert all headers to arrays. - if (!Array.isArray(header)) { - header = [header]; + // Stops a timeout from triggering + function clearTimer() { + // Clear the timeout + if (self._timeout) { + clearTimeout(self._timeout); + self._timeout = null; } - // add non-empty headers. - if (header.length) { - contents += prop + ': ' + header.join('; ') + FormData.LINE_BREAK; + // Clean up all attached listeners + self.removeListener("abort", clearTimer); + self.removeListener("error", clearTimer); + self.removeListener("response", clearTimer); + if (callback) { + self.removeListener("timeout", callback); + } + if (!self.socket) { + self._currentRequest.removeListener("socket", startTimer); } } - return '--' + this.getBoundary() + FormData.LINE_BREAK + contents + FormData.LINE_BREAK; -}; - -FormData.prototype._getContentDisposition = function(value, options) { - - var filename - , contentDisposition - ; - - if (typeof options.filepath === 'string') { - // custom filepath for relative paths - filename = path.normalize(options.filepath).replace(/\\/g, '/'); - } else if (options.filename || value.name || value.path) { - // custom filename take precedence - // formidable and the browser add a name property - // fs- and request- streams have path property - filename = path.basename(options.filename || value.name || value.path); - } else if (value.readable && value.hasOwnProperty('httpVersion')) { - // or try http response - filename = path.basename(value.client._httpMessage.path || ''); + // Attach callback if passed + if (callback) { + this.on("timeout", callback); } - if (filename) { - contentDisposition = 'filename="' + filename + '"'; + // Start the timer if or when the socket is opened + if (this.socket) { + startTimer(this.socket); + } + else { + this._currentRequest.once("socket", startTimer); } - return contentDisposition; + // Clean up on events + this.on("socket", destroyOnTimeout); + this.on("abort", clearTimer); + this.on("error", clearTimer); + this.on("response", clearTimer); + + return this; }; -FormData.prototype._getContentType = function(value, options) { +// Proxy all other public ClientRequest methods +[ + "flushHeaders", "getHeader", + "setNoDelay", "setSocketKeepAlive", +].forEach(function (method) { + RedirectableRequest.prototype[method] = function (a, b) { + return this._currentRequest[method](a, b); + }; +}); - // use custom content-type above all - var contentType = options.contentType; +// Proxy all public ClientRequest properties +["aborted", "connection", "socket"].forEach(function (property) { + Object.defineProperty(RedirectableRequest.prototype, property, { + get: function () { return this._currentRequest[property]; }, + }); +}); - // or try `name` from formidable, browser - if (!contentType && value.name) { - contentType = mime.lookup(value.name); +RedirectableRequest.prototype._sanitizeOptions = function (options) { + // Ensure headers are always present + if (!options.headers) { + options.headers = {}; } - // or try `path` from fs-, request- streams - if (!contentType && value.path) { - contentType = mime.lookup(value.path); + // Since http.request treats host as an alias of hostname, + // but the url module interprets host as hostname plus port, + // eliminate the host property to avoid confusion. + if (options.host) { + // Use hostname if set, because it has precedence + if (!options.hostname) { + options.hostname = options.host; + } + delete options.host; } - // or if it's http-reponse - if (!contentType && value.readable && value.hasOwnProperty('httpVersion')) { - contentType = value.headers['content-type']; + // Complete the URL object when necessary + if (!options.pathname && options.path) { + var searchPos = options.path.indexOf("?"); + if (searchPos < 0) { + options.pathname = options.path; + } + else { + options.pathname = options.path.substring(0, searchPos); + options.search = options.path.substring(searchPos); + } } +}; - // or guess it from the filepath or filename - if (!contentType && (options.filepath || options.filename)) { - contentType = mime.lookup(options.filepath || options.filename); - } - // fallback to the default content type if `value` is not simple value - if (!contentType && typeof value == 'object') { - contentType = FormData.DEFAULT_CONTENT_TYPE; +// Executes the next native request (initial or redirect) +RedirectableRequest.prototype._performRequest = function () { + // Load the native protocol + var protocol = this._options.protocol; + var nativeProtocol = this._options.nativeProtocols[protocol]; + if (!nativeProtocol) { + this.emit("error", new TypeError("Unsupported protocol " + protocol)); + return; } - return contentType; -}; + // If specified, use the agent corresponding to the protocol + // (HTTP and HTTPS use different types of agents) + if (this._options.agents) { + var scheme = protocol.slice(0, -1); + this._options.agent = this._options.agents[scheme]; + } -FormData.prototype._multiPartFooter = function() { - return function(next) { - var footer = FormData.LINE_BREAK; - - var lastPart = (this._streams.length === 0); - if (lastPart) { - footer += this._lastBoundary(); - } - - next(footer); - }.bind(this); -}; - -FormData.prototype._lastBoundary = function() { - return '--' + this.getBoundary() + '--' + FormData.LINE_BREAK; -}; - -FormData.prototype.getHeaders = function(userHeaders) { - var header; - var formHeaders = { - 'content-type': 'multipart/form-data; boundary=' + this.getBoundary() - }; + // Create the native request + var request = this._currentRequest = + nativeProtocol.request(this._options, this._onNativeResponse); + this._currentUrl = url.format(this._options); - for (header in userHeaders) { - if (userHeaders.hasOwnProperty(header)) { - formHeaders[header.toLowerCase()] = userHeaders[header]; - } + // Set up event handlers + request._redirectable = this; + for (var e = 0; e < events.length; e++) { + request.on(events[e], eventHandlers[events[e]]); } - return formHeaders; -}; - -FormData.prototype.setBoundary = function(boundary) { - this._boundary = boundary; -}; - -FormData.prototype.getBoundary = function() { - if (!this._boundary) { - this._generateBoundary(); + // End a redirected request + // (The first request must be ended explicitly with RedirectableRequest#end) + if (this._isRedirect) { + // Write the request entity and end. + var i = 0; + var self = this; + var buffers = this._requestBodyBuffers; + (function writeNext(error) { + // Only write if this request has not been redirected yet + /* istanbul ignore else */ + if (request === self._currentRequest) { + // Report any write errors + /* istanbul ignore if */ + if (error) { + self.emit("error", error); + } + // Write the next buffer if there are still left + else if (i < buffers.length) { + var buffer = buffers[i++]; + /* istanbul ignore else */ + if (!request.finished) { + request.write(buffer.data, buffer.encoding, writeNext); + } + } + // End the request if `end` has been called on us + else if (self._ended) { + request.end(); + } + } + }()); } - - return this._boundary; }; -FormData.prototype.getBuffer = function() { - var dataBuffer = new Buffer.alloc( 0 ); - var boundary = this.getBoundary(); +// Processes a response from the current native request +RedirectableRequest.prototype._processResponse = function (response) { + // Store the redirected response + var statusCode = response.statusCode; + if (this._options.trackRedirects) { + this._redirects.push({ + url: this._currentUrl, + headers: response.headers, + statusCode: statusCode, + }); + } - // Create the form content. Add Line breaks to the end of data. - for (var i = 0, len = this._streams.length; i < len; i++) { - if (typeof this._streams[i] !== 'function') { + // RFC7231§6.4: The 3xx (Redirection) class of status code indicates + // that further action needs to be taken by the user agent in order to + // fulfill the request. If a Location header field is provided, + // the user agent MAY automatically redirect its request to the URI + // referenced by the Location field value, + // even if the specific status code is not understood. - // Add content to the buffer. - if(Buffer.isBuffer(this._streams[i])) { - dataBuffer = Buffer.concat( [dataBuffer, this._streams[i]]); - }else { - dataBuffer = Buffer.concat( [dataBuffer, Buffer.from(this._streams[i])]); - } + // If the response is not a redirect; return it as-is + var location = response.headers.location; + if (!location || this._options.followRedirects === false || + statusCode < 300 || statusCode >= 400) { + response.responseUrl = this._currentUrl; + response.redirects = this._redirects; + this.emit("response", response); - // Add break after content. - if (typeof this._streams[i] !== 'string' || this._streams[i].substring( 2, boundary.length + 2 ) !== boundary) { - dataBuffer = Buffer.concat( [dataBuffer, Buffer.from(FormData.LINE_BREAK)] ); - } - } + // Clean up + this._requestBodyBuffers = []; + return; } - // Add the footer and return the Buffer object. - return Buffer.concat( [dataBuffer, Buffer.from(this._lastBoundary())] ); -}; + // The response is a redirect, so abort the current request + abortRequest(this._currentRequest); + // Discard the remainder of the response to avoid waiting for data + response.destroy(); -FormData.prototype._generateBoundary = function() { - // This generates a 50 character boundary similar to those used by Firefox. - // They are optimized for boyer-moore parsing. - var boundary = '--------------------------'; - for (var i = 0; i < 24; i++) { - boundary += Math.floor(Math.random() * 10).toString(16); + // RFC7231§6.4: A client SHOULD detect and intervene + // in cyclical redirections (i.e., "infinite" redirection loops). + if (++this._redirectCount > this._options.maxRedirects) { + this.emit("error", new TooManyRedirectsError()); + return; } - this._boundary = boundary; -}; - -// Note: getLengthSync DOESN'T calculate streams length -// As workaround one can calculate file size manually -// and add it as knownLength option -FormData.prototype.getLengthSync = function() { - var knownLength = this._overheadLength + this._valueLength; - - // Don't get confused, there are 3 "internal" streams for each keyval pair - // so it basically checks if there is any value added to the form - if (this._streams.length) { - knownLength += this._lastBoundary().length; + // Store the request headers if applicable + var requestHeaders; + var beforeRedirect = this._options.beforeRedirect; + if (beforeRedirect) { + requestHeaders = Object.assign({ + // The Host header was set by nativeProtocol.request + Host: response.req.getHeader("host"), + }, this._options.headers); } - // https://github.com/form-data/form-data/issues/40 - if (!this.hasKnownLength()) { - // Some async length retrievers are present - // therefore synchronous length calculation is false. - // Please use getLength(callback) to get proper length - this._error(new Error('Cannot calculate proper length in synchronous way.')); + // RFC7231§6.4: Automatic redirection needs to done with + // care for methods not known to be safe, […] + // RFC7231§6.4.2–3: For historical reasons, a user agent MAY change + // the request method from POST to GET for the subsequent request. + var method = this._options.method; + if ((statusCode === 301 || statusCode === 302) && this._options.method === "POST" || + // RFC7231§6.4.4: The 303 (See Other) status code indicates that + // the server is redirecting the user agent to a different resource […] + // A user agent can perform a retrieval request targeting that URI + // (a GET or HEAD request if using HTTP) […] + (statusCode === 303) && !/^(?:GET|HEAD)$/.test(this._options.method)) { + this._options.method = "GET"; + // Drop a possible entity and headers related to it + this._requestBodyBuffers = []; + removeMatchingHeaders(/^content-/i, this._options.headers); } - return knownLength; -}; + // Drop the Host header, as the redirect might lead to a different host + var currentHostHeader = removeMatchingHeaders(/^host$/i, this._options.headers); -// Public API to check if length of added values is known -// https://github.com/form-data/form-data/issues/196 -// https://github.com/form-data/form-data/issues/262 -FormData.prototype.hasKnownLength = function() { - var hasKnownLength = true; + // If the redirect is relative, carry over the host of the last request + var currentUrlParts = url.parse(this._currentUrl); + var currentHost = currentHostHeader || currentUrlParts.host; + var currentUrl = /^\w+:/.test(location) ? this._currentUrl : + url.format(Object.assign(currentUrlParts, { host: currentHost })); - if (this._valuesToMeasure.length) { - hasKnownLength = false; + // Determine the URL of the redirection + var redirectUrl; + try { + redirectUrl = url.resolve(currentUrl, location); } - - return hasKnownLength; -}; - -FormData.prototype.getLength = function(cb) { - var knownLength = this._overheadLength + this._valueLength; - - if (this._streams.length) { - knownLength += this._lastBoundary().length; + catch (cause) { + this.emit("error", new RedirectionError(cause)); + return; } - if (!this._valuesToMeasure.length) { - process.nextTick(cb.bind(this, null, knownLength)); - return; + // Create the redirected request + debug("redirecting to", redirectUrl); + this._isRedirect = true; + var redirectUrlParts = url.parse(redirectUrl); + Object.assign(this._options, redirectUrlParts); + + // Drop confidential headers when redirecting to a less secure protocol + // or to a different domain that is not a superdomain + if (redirectUrlParts.protocol !== currentUrlParts.protocol && + redirectUrlParts.protocol !== "https:" || + redirectUrlParts.host !== currentHost && + !isSubdomain(redirectUrlParts.host, currentHost)) { + removeMatchingHeaders(/^(?:authorization|cookie)$/i, this._options.headers); } - asynckit.parallel(this._valuesToMeasure, this._lengthRetriever, function(err, values) { - if (err) { - cb(err); + // Evaluate the beforeRedirect callback + if (typeof beforeRedirect === "function") { + var responseDetails = { + headers: response.headers, + statusCode: statusCode, + }; + var requestDetails = { + url: currentUrl, + method: method, + headers: requestHeaders, + }; + try { + beforeRedirect(this._options, responseDetails, requestDetails); + } + catch (err) { + this.emit("error", err); return; } + this._sanitizeOptions(this._options); + } - values.forEach(function(length) { - knownLength += length; - }); - - cb(null, knownLength); - }); -}; - -FormData.prototype.submit = function(params, cb) { - var request - , options - , defaults = {method: 'post'} - ; - - // parse provided url if it's string - // or treat it as options object - if (typeof params == 'string') { - - params = parseUrl(params); - options = populate({ - port: params.port, - path: params.pathname, - host: params.hostname, - protocol: params.protocol - }, defaults); + // Perform the redirected request + try { + this._performRequest(); + } + catch (cause) { + this.emit("error", new RedirectionError(cause)); + } +}; - // use custom params - } else { +// Wraps the key/value object of protocols with redirect functionality +function wrap(protocols) { + // Default settings + var exports = { + maxRedirects: 21, + maxBodyLength: 10 * 1024 * 1024, + }; - options = populate(params, defaults); - // if no port provided use default one - if (!options.port) { - options.port = options.protocol == 'https:' ? 443 : 80; - } - } + // Wrap each protocol + var nativeProtocols = {}; + Object.keys(protocols).forEach(function (scheme) { + var protocol = scheme + ":"; + var nativeProtocol = nativeProtocols[protocol] = protocols[scheme]; + var wrappedProtocol = exports[scheme] = Object.create(nativeProtocol); - // put that good code in getHeaders to some use - options.headers = this.getHeaders(params.headers); + // Executes a request, following redirects + function request(input, options, callback) { + // Parse parameters + if (typeof input === "string") { + var urlStr = input; + try { + input = urlToOptions(new URL(urlStr)); + } + catch (err) { + /* istanbul ignore next */ + input = url.parse(urlStr); + } + } + else if (URL && (input instanceof URL)) { + input = urlToOptions(input); + } + else { + callback = options; + options = input; + input = { protocol: protocol }; + } + if (typeof options === "function") { + callback = options; + options = null; + } - // https if specified, fallback to http in any other case - if (options.protocol == 'https:') { - request = https.request(options); - } else { - request = http.request(options); - } + // Set defaults + options = Object.assign({ + maxRedirects: exports.maxRedirects, + maxBodyLength: exports.maxBodyLength, + }, input, options); + options.nativeProtocols = nativeProtocols; - // get content length and fire away - this.getLength(function(err, length) { - if (err && err !== 'Unknown stream') { - this._error(err); - return; + assert.equal(options.protocol, protocol, "protocol mismatch"); + debug("options", options); + return new RedirectableRequest(options, callback); } - // add content length - if (length) { - request.setHeader('Content-Length', length); + // Executes a GET request, following redirects + function get(input, options, callback) { + var wrappedRequest = wrappedProtocol.request(input, options, callback); + wrappedRequest.end(); + return wrappedRequest; } - this.pipe(request); - if (cb) { - var onResponse; - - var callback = function (error, responce) { - request.removeListener('error', callback); - request.removeListener('response', onResponse); + // Expose the properties on the wrapped protocol + Object.defineProperties(wrappedProtocol, { + request: { value: request, configurable: true, enumerable: true, writable: true }, + get: { value: get, configurable: true, enumerable: true, writable: true }, + }); + }); + return exports; +} - return cb.call(this, error, responce); - }; +/* istanbul ignore next */ +function noop() { /* empty */ } - onResponse = callback.bind(this, null); +// from https://github.com/nodejs/node/blob/master/lib/internal/url.js +function urlToOptions(urlObject) { + var options = { + protocol: urlObject.protocol, + hostname: urlObject.hostname.startsWith("[") ? + /* istanbul ignore next */ + urlObject.hostname.slice(1, -1) : + urlObject.hostname, + hash: urlObject.hash, + search: urlObject.search, + pathname: urlObject.pathname, + path: urlObject.pathname + urlObject.search, + href: urlObject.href, + }; + if (urlObject.port !== "") { + options.port = Number(urlObject.port); + } + return options; +} - request.on('error', callback); - request.on('response', onResponse); +function removeMatchingHeaders(regex, headers) { + var lastValue; + for (var header in headers) { + if (regex.test(header)) { + lastValue = headers[header]; + delete headers[header]; } - }.bind(this)); + } + return (lastValue === null || typeof lastValue === "undefined") ? + undefined : String(lastValue).trim(); +} - return request; -}; +function createErrorType(code, defaultMessage) { + function CustomError(cause) { + Error.captureStackTrace(this, this.constructor); + if (!cause) { + this.message = defaultMessage; + } + else { + this.message = defaultMessage + ": " + cause.message; + this.cause = cause; + } + } + CustomError.prototype = new Error(); + CustomError.prototype.constructor = CustomError; + CustomError.prototype.name = "Error [" + code + "]"; + CustomError.prototype.code = code; + return CustomError; +} -FormData.prototype._error = function(err) { - if (!this.error) { - this.error = err; - this.pause(); - this.emit('error', err); +function abortRequest(request) { + for (var e = 0; e < events.length; e++) { + request.removeListener(events[e], eventHandlers[events[e]]); } -}; + request.on("error", noop); + request.abort(); +} -FormData.prototype.toString = function () { - return '[object FormData]'; -}; +function isSubdomain(subdomain, domain) { + const dot = subdomain.length - domain.length - 1; + return dot > 0 && subdomain[dot] === "." && subdomain.endsWith(domain); +} + +// Exports +module.exports = wrap({ http: http, https: https }); +module.exports.wrap = wrap; /***/ }), -/***/ "../../node_modules/form-data/lib/populate.js": -/***/ (function(module, exports) { +/***/ "../../node_modules/form-data/lib/form_data.js": +/***/ (function(module, exports, __webpack_require__) { -// populates missing values -module.exports = function(dst, src) { +var CombinedStream = __webpack_require__("../../node_modules/combined-stream/lib/combined_stream.js"); +var util = __webpack_require__("util"); +var path = __webpack_require__("path"); +var http = __webpack_require__("http"); +var https = __webpack_require__("https"); +var parseUrl = __webpack_require__("url").parse; +var fs = __webpack_require__("fs"); +var Stream = __webpack_require__("stream").Stream; +var mime = __webpack_require__("../../node_modules/mime-types/index.js"); +var asynckit = __webpack_require__("../../node_modules/asynckit/index.js"); +var populate = __webpack_require__("../../node_modules/form-data/lib/populate.js"); - Object.keys(src).forEach(function(prop) - { - dst[prop] = dst[prop] || src[prop]; - }); +// Public API +module.exports = FormData; - return dst; -}; +// make it a Stream +util.inherits(FormData, CombinedStream); +/** + * Create readable "multipart/form-data" streams. + * Can be used to submit forms + * and file uploads to other web applications. + * + * @constructor + * @param {Object} options - Properties to be added/overriden for FormData and CombinedStream + */ +function FormData(options) { + if (!(this instanceof FormData)) { + return new FormData(options); + } -/***/ }), + this._overheadLength = 0; + this._valueLength = 0; + this._valuesToMeasure = []; -/***/ "../../node_modules/fs.realpath/index.js": -/***/ (function(module, exports, __webpack_require__) { + CombinedStream.call(this); -module.exports = realpath -realpath.realpath = realpath -realpath.sync = realpathSync -realpath.realpathSync = realpathSync -realpath.monkeypatch = monkeypatch -realpath.unmonkeypatch = unmonkeypatch + options = options || {}; + for (var option in options) { + this[option] = options[option]; + } +} -var fs = __webpack_require__("fs") -var origRealpath = fs.realpath -var origRealpathSync = fs.realpathSync +FormData.LINE_BREAK = '\r\n'; +FormData.DEFAULT_CONTENT_TYPE = 'application/octet-stream'; -var version = process.version -var ok = /^v[0-5]\./.test(version) -var old = __webpack_require__("../../node_modules/fs.realpath/old.js") +FormData.prototype.append = function(field, value, options) { -function newError (er) { - return er && er.syscall === 'realpath' && ( - er.code === 'ELOOP' || - er.code === 'ENOMEM' || - er.code === 'ENAMETOOLONG' - ) -} + options = options || {}; -function realpath (p, cache, cb) { - if (ok) { - return origRealpath(p, cache, cb) + // allow filename as single option + if (typeof options == 'string') { + options = {filename: options}; } - if (typeof cache === 'function') { - cb = cache - cache = null - } - origRealpath(p, cache, function (er, result) { - if (newError(er)) { - old.realpath(p, cache, cb) - } else { - cb(er, result) - } - }) -} + var append = CombinedStream.prototype.append.bind(this); -function realpathSync (p, cache) { - if (ok) { - return origRealpathSync(p, cache) + // all that streamy business can't handle numbers + if (typeof value == 'number') { + value = '' + value; } - try { - return origRealpathSync(p, cache) - } catch (er) { - if (newError(er)) { - return old.realpathSync(p, cache) - } else { - throw er - } + // https://github.com/felixge/node-form-data/issues/38 + if (util.isArray(value)) { + // Please convert your array into string + // the way web server expects it + this._error(new Error('Arrays are not supported.')); + return; } -} - -function monkeypatch () { - fs.realpath = realpath - fs.realpathSync = realpathSync -} - -function unmonkeypatch () { - fs.realpath = origRealpath - fs.realpathSync = origRealpathSync -} - - -/***/ }), -/***/ "../../node_modules/fs.realpath/old.js": -/***/ (function(module, exports, __webpack_require__) { + var header = this._multiPartHeader(field, value, options); + var footer = this._multiPartFooter(); -// Copyright Joyent, Inc. and other Node contributors. -// -// Permission is hereby granted, free of charge, to any person obtaining a -// copy of this software and associated documentation files (the -// "Software"), to deal in the Software without restriction, including -// without limitation the rights to use, copy, modify, merge, publish, -// distribute, sublicense, and/or sell copies of the Software, and to permit -// persons to whom the Software is furnished to do so, subject to the -// following conditions: -// -// The above copyright notice and this permission notice shall be included -// in all copies or substantial portions of the Software. -// -// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS -// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN -// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, -// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR -// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE -// USE OR OTHER DEALINGS IN THE SOFTWARE. + append(header); + append(value); + append(footer); -var pathModule = __webpack_require__("path"); -var isWindows = process.platform === 'win32'; -var fs = __webpack_require__("fs"); + // pass along options.knownLength + this._trackLength(header, value, options); +}; -// JavaScript implementation of realpath, ported from node pre-v6 +FormData.prototype._trackLength = function(header, value, options) { + var valueLength = 0; -var DEBUG = process.env.NODE_DEBUG && /fs/.test(process.env.NODE_DEBUG); + // used w/ getLengthSync(), when length is known. + // e.g. for streaming directly from a remote server, + // w/ a known file a size, and not wanting to wait for + // incoming file to finish to get its size. + if (options.knownLength != null) { + valueLength += +options.knownLength; + } else if (Buffer.isBuffer(value)) { + valueLength = value.length; + } else if (typeof value === 'string') { + valueLength = Buffer.byteLength(value); + } -function rethrow() { - // Only enable in debug mode. A backtrace uses ~1000 bytes of heap space and - // is fairly slow to generate. - var callback; - if (DEBUG) { - var backtrace = new Error; - callback = debugCallback; - } else - callback = missingCallback; + this._valueLength += valueLength; - return callback; + // @check why add CRLF? does this account for custom/multiple CRLFs? + this._overheadLength += + Buffer.byteLength(header) + + FormData.LINE_BREAK.length; - function debugCallback(err) { - if (err) { - backtrace.message = err.message; - err = backtrace; - missingCallback(err); - } + // empty or either doesn't have path or not an http response or not a stream + if (!value || ( !value.path && !(value.readable && value.hasOwnProperty('httpVersion')) && !(value instanceof Stream))) { + return; } - function missingCallback(err) { - if (err) { - if (process.throwDeprecation) - throw err; // Forgot a callback but don't know where? Use NODE_DEBUG=fs - else if (!process.noDeprecation) { - var msg = 'fs: missing callback ' + (err.stack || err.message); - if (process.traceDeprecation) - console.trace(msg); - else - console.error(msg); - } - } + // no need to bother with the length + if (!options.knownLength) { + this._valuesToMeasure.push(value); } -} +}; -function maybeCallback(cb) { - return typeof cb === 'function' ? cb : rethrow(); -} +FormData.prototype._lengthRetriever = function(value, callback) { -var normalize = pathModule.normalize; + if (value.hasOwnProperty('fd')) { -// Regexp that finds the next partion of a (partial) path -// result is [base_with_slash, base], e.g. ['somedir/', 'somedir'] -if (isWindows) { - var nextPartRe = /(.*?)(?:[\/\\]+|$)/g; -} else { - var nextPartRe = /(.*?)(?:[\/]+|$)/g; -} + // take read range into a account + // `end` = Infinity –> read file till the end + // + // TODO: Looks like there is bug in Node fs.createReadStream + // it doesn't respect `end` options without `start` options + // Fix it when node fixes it. + // https://github.com/joyent/node/issues/7819 + if (value.end != undefined && value.end != Infinity && value.start != undefined) { -// Regex to find the device root, including trailing slash. E.g. 'c:\\'. -if (isWindows) { - var splitRootRe = /^(?:[a-zA-Z]:|[\\\/]{2}[^\\\/]+[\\\/][^\\\/]+)?[\\\/]*/; -} else { - var splitRootRe = /^[\/]*/; -} + // when end specified + // no need to calculate range + // inclusive, starts with 0 + callback(null, value.end + 1 - (value.start ? value.start : 0)); -exports.realpathSync = function realpathSync(p, cache) { - // make p is absolute - p = pathModule.resolve(p); + // not that fast snoopy + } else { + // still need to fetch file size from fs + fs.stat(value.path, function(err, stat) { - if (cache && Object.prototype.hasOwnProperty.call(cache, p)) { - return cache[p]; - } + var fileSize; - var original = p, - seenLinks = {}, - knownHard = {}; + if (err) { + callback(err); + return; + } - // current character position in p - var pos; - // the partial path so far, including a trailing slash if any - var current; - // the partial path without a trailing slash (except when pointing at a root) - var base; - // the partial path scanned in the previous round, with slash - var previous; + // update final size based on the range options + fileSize = stat.size - (value.start ? value.start : 0); + callback(null, fileSize); + }); + } - start(); + // or http response + } else if (value.hasOwnProperty('httpVersion')) { + callback(null, +value.headers['content-length']); - function start() { - // Skip over roots - var m = splitRootRe.exec(p); - pos = m[0].length; - current = m[0]; - base = m[0]; - previous = ''; + // or request stream http://github.com/mikeal/request + } else if (value.hasOwnProperty('httpModule')) { + // wait till response come back + value.on('response', function(response) { + value.pause(); + callback(null, +response.headers['content-length']); + }); + value.resume(); - // On windows, check that the root exists. On unix there is no need. - if (isWindows && !knownHard[base]) { - fs.lstatSync(base); - knownHard[base] = true; - } + // something else + } else { + callback('Unknown stream'); } +}; - // walk down the path, swapping out linked pathparts for their real - // values - // NB: p.length changes. - while (pos < p.length) { - // find the next part - nextPartRe.lastIndex = pos; - var result = nextPartRe.exec(p); - previous = current; - current += result[0]; - base = previous + result[1]; - pos = nextPartRe.lastIndex; - - // continue if not a symlink - if (knownHard[base] || (cache && cache[base] === base)) { - continue; - } +FormData.prototype._multiPartHeader = function(field, value, options) { + // custom header specified (as string)? + // it becomes responsible for boundary + // (e.g. to handle extra CRLFs on .NET servers) + if (typeof options.header == 'string') { + return options.header; + } - var resolvedLink; - if (cache && Object.prototype.hasOwnProperty.call(cache, base)) { - // some known symbolic link. no need to stat again. - resolvedLink = cache[base]; - } else { - var stat = fs.lstatSync(base); - if (!stat.isSymbolicLink()) { - knownHard[base] = true; - if (cache) cache[base] = base; - continue; - } + var contentDisposition = this._getContentDisposition(value, options); + var contentType = this._getContentType(value, options); - // read the link if it wasn't read before - // dev/ino always return 0 on windows, so skip the check. - var linkTarget = null; - if (!isWindows) { - var id = stat.dev.toString(32) + ':' + stat.ino.toString(32); - if (seenLinks.hasOwnProperty(id)) { - linkTarget = seenLinks[id]; - } - } - if (linkTarget === null) { - fs.statSync(base); - linkTarget = fs.readlinkSync(base); - } - resolvedLink = pathModule.resolve(previous, linkTarget); - // track this, if given a cache. - if (cache) cache[base] = resolvedLink; - if (!isWindows) seenLinks[id] = linkTarget; - } + var contents = ''; + var headers = { + // add custom disposition as third element or keep it two elements if not + 'Content-Disposition': ['form-data', 'name="' + field + '"'].concat(contentDisposition || []), + // if no content type. allow it to be empty array + 'Content-Type': [].concat(contentType || []) + }; - // resolve the link, then start over - p = pathModule.resolve(resolvedLink, p.slice(pos)); - start(); + // allow custom headers. + if (typeof options.header == 'object') { + populate(headers, options.header); } - if (cache) cache[original] = p; + var header; + for (var prop in headers) { + if (!headers.hasOwnProperty(prop)) continue; + header = headers[prop]; - return p; -}; + // skip nullish headers. + if (header == null) { + continue; + } + // convert all headers to arrays. + if (!Array.isArray(header)) { + header = [header]; + } -exports.realpath = function realpath(p, cache, cb) { - if (typeof cb !== 'function') { - cb = maybeCallback(cache); - cache = null; + // add non-empty headers. + if (header.length) { + contents += prop + ': ' + header.join('; ') + FormData.LINE_BREAK; + } } - // make p is absolute - p = pathModule.resolve(p); + return '--' + this.getBoundary() + FormData.LINE_BREAK + contents + FormData.LINE_BREAK; +}; - if (cache && Object.prototype.hasOwnProperty.call(cache, p)) { - return process.nextTick(cb.bind(null, null, cache[p])); +FormData.prototype._getContentDisposition = function(value, options) { + + var filename + , contentDisposition + ; + + if (typeof options.filepath === 'string') { + // custom filepath for relative paths + filename = path.normalize(options.filepath).replace(/\\/g, '/'); + } else if (options.filename || value.name || value.path) { + // custom filename take precedence + // formidable and the browser add a name property + // fs- and request- streams have path property + filename = path.basename(options.filename || value.name || value.path); + } else if (value.readable && value.hasOwnProperty('httpVersion')) { + // or try http response + filename = path.basename(value.client._httpMessage.path || ''); } - var original = p, - seenLinks = {}, - knownHard = {}; + if (filename) { + contentDisposition = 'filename="' + filename + '"'; + } - // current character position in p - var pos; - // the partial path so far, including a trailing slash if any - var current; - // the partial path without a trailing slash (except when pointing at a root) - var base; - // the partial path scanned in the previous round, with slash - var previous; + return contentDisposition; +}; - start(); +FormData.prototype._getContentType = function(value, options) { - function start() { - // Skip over roots - var m = splitRootRe.exec(p); - pos = m[0].length; - current = m[0]; - base = m[0]; - previous = ''; + // use custom content-type above all + var contentType = options.contentType; - // On windows, check that the root exists. On unix there is no need. - if (isWindows && !knownHard[base]) { - fs.lstat(base, function(err) { - if (err) return cb(err); - knownHard[base] = true; - LOOP(); - }); - } else { - process.nextTick(LOOP); - } + // or try `name` from formidable, browser + if (!contentType && value.name) { + contentType = mime.lookup(value.name); } - // walk down the path, swapping out linked pathparts for their real - // values - function LOOP() { - // stop if scanned past end of path - if (pos >= p.length) { - if (cache) cache[original] = p; - return cb(null, p); - } - - // find the next part - nextPartRe.lastIndex = pos; - var result = nextPartRe.exec(p); - previous = current; - current += result[0]; - base = previous + result[1]; - pos = nextPartRe.lastIndex; + // or try `path` from fs-, request- streams + if (!contentType && value.path) { + contentType = mime.lookup(value.path); + } - // continue if not a symlink - if (knownHard[base] || (cache && cache[base] === base)) { - return process.nextTick(LOOP); - } + // or if it's http-reponse + if (!contentType && value.readable && value.hasOwnProperty('httpVersion')) { + contentType = value.headers['content-type']; + } - if (cache && Object.prototype.hasOwnProperty.call(cache, base)) { - // known symbolic link. no need to stat again. - return gotResolvedLink(cache[base]); - } + // or guess it from the filepath or filename + if (!contentType && (options.filepath || options.filename)) { + contentType = mime.lookup(options.filepath || options.filename); + } - return fs.lstat(base, gotStat); + // fallback to the default content type if `value` is not simple value + if (!contentType && typeof value == 'object') { + contentType = FormData.DEFAULT_CONTENT_TYPE; } - function gotStat(err, stat) { - if (err) return cb(err); + return contentType; +}; - // if not a symlink, skip to the next path part - if (!stat.isSymbolicLink()) { - knownHard[base] = true; - if (cache) cache[base] = base; - return process.nextTick(LOOP); - } +FormData.prototype._multiPartFooter = function() { + return function(next) { + var footer = FormData.LINE_BREAK; - // stat & read the link if not read before - // call gotTarget as soon as the link target is known - // dev/ino always return 0 on windows, so skip the check. - if (!isWindows) { - var id = stat.dev.toString(32) + ':' + stat.ino.toString(32); - if (seenLinks.hasOwnProperty(id)) { - return gotTarget(null, seenLinks[id], base); - } + var lastPart = (this._streams.length === 0); + if (lastPart) { + footer += this._lastBoundary(); } - fs.stat(base, function(err) { - if (err) return cb(err); - fs.readlink(base, function(err, target) { - if (!isWindows) seenLinks[id] = target; - gotTarget(err, target); - }); - }); - } + next(footer); + }.bind(this); +}; - function gotTarget(err, target, base) { - if (err) return cb(err); +FormData.prototype._lastBoundary = function() { + return '--' + this.getBoundary() + '--' + FormData.LINE_BREAK; +}; - var resolvedLink = pathModule.resolve(previous, target); - if (cache) cache[base] = resolvedLink; - gotResolvedLink(resolvedLink); - } +FormData.prototype.getHeaders = function(userHeaders) { + var header; + var formHeaders = { + 'content-type': 'multipart/form-data; boundary=' + this.getBoundary() + }; - function gotResolvedLink(resolvedLink) { - // resolve the link, then start over - p = pathModule.resolve(resolvedLink, p.slice(pos)); - start(); + for (header in userHeaders) { + if (userHeaders.hasOwnProperty(header)) { + formHeaders[header.toLowerCase()] = userHeaders[header]; + } } + + return formHeaders; }; +FormData.prototype.setBoundary = function(boundary) { + this._boundary = boundary; +}; -/***/ }), +FormData.prototype.getBoundary = function() { + if (!this._boundary) { + this._generateBoundary(); + } -/***/ "../../node_modules/function-bind/implementation.js": -/***/ (function(module, exports, __webpack_require__) { + return this._boundary; +}; -"use strict"; +FormData.prototype.getBuffer = function() { + var dataBuffer = new Buffer.alloc( 0 ); + var boundary = this.getBoundary(); + // Create the form content. Add Line breaks to the end of data. + for (var i = 0, len = this._streams.length; i < len; i++) { + if (typeof this._streams[i] !== 'function') { -/* eslint no-invalid-this: 1 */ - -var ERROR_MESSAGE = 'Function.prototype.bind called on incompatible '; -var slice = Array.prototype.slice; -var toStr = Object.prototype.toString; -var funcType = '[object Function]'; + // Add content to the buffer. + if(Buffer.isBuffer(this._streams[i])) { + dataBuffer = Buffer.concat( [dataBuffer, this._streams[i]]); + }else { + dataBuffer = Buffer.concat( [dataBuffer, Buffer.from(this._streams[i])]); + } -module.exports = function bind(that) { - var target = this; - if (typeof target !== 'function' || toStr.call(target) !== funcType) { - throw new TypeError(ERROR_MESSAGE + target); + // Add break after content. + if (typeof this._streams[i] !== 'string' || this._streams[i].substring( 2, boundary.length + 2 ) !== boundary) { + dataBuffer = Buffer.concat( [dataBuffer, Buffer.from(FormData.LINE_BREAK)] ); + } } - var args = slice.call(arguments, 1); + } - var bound; - var binder = function () { - if (this instanceof bound) { - var result = target.apply( - this, - args.concat(slice.call(arguments)) - ); - if (Object(result) === result) { - return result; - } - return this; - } else { - return target.apply( - that, - args.concat(slice.call(arguments)) - ); - } - }; + // Add the footer and return the Buffer object. + return Buffer.concat( [dataBuffer, Buffer.from(this._lastBoundary())] ); +}; - var boundLength = Math.max(0, target.length - args.length); - var boundArgs = []; - for (var i = 0; i < boundLength; i++) { - boundArgs.push('$' + i); - } +FormData.prototype._generateBoundary = function() { + // This generates a 50 character boundary similar to those used by Firefox. + // They are optimized for boyer-moore parsing. + var boundary = '--------------------------'; + for (var i = 0; i < 24; i++) { + boundary += Math.floor(Math.random() * 10).toString(16); + } - bound = Function('binder', 'return function (' + boundArgs.join(',') + '){ return binder.apply(this,arguments); }')(binder); + this._boundary = boundary; +}; - if (target.prototype) { - var Empty = function Empty() {}; - Empty.prototype = target.prototype; - bound.prototype = new Empty(); - Empty.prototype = null; - } +// Note: getLengthSync DOESN'T calculate streams length +// As workaround one can calculate file size manually +// and add it as knownLength option +FormData.prototype.getLengthSync = function() { + var knownLength = this._overheadLength + this._valueLength; - return bound; + // Don't get confused, there are 3 "internal" streams for each keyval pair + // so it basically checks if there is any value added to the form + if (this._streams.length) { + knownLength += this._lastBoundary().length; + } + + // https://github.com/form-data/form-data/issues/40 + if (!this.hasKnownLength()) { + // Some async length retrievers are present + // therefore synchronous length calculation is false. + // Please use getLength(callback) to get proper length + this._error(new Error('Cannot calculate proper length in synchronous way.')); + } + + return knownLength; }; +// Public API to check if length of added values is known +// https://github.com/form-data/form-data/issues/196 +// https://github.com/form-data/form-data/issues/262 +FormData.prototype.hasKnownLength = function() { + var hasKnownLength = true; -/***/ }), + if (this._valuesToMeasure.length) { + hasKnownLength = false; + } -/***/ "../../node_modules/function-bind/index.js": -/***/ (function(module, exports, __webpack_require__) { + return hasKnownLength; +}; -"use strict"; +FormData.prototype.getLength = function(cb) { + var knownLength = this._overheadLength + this._valueLength; + if (this._streams.length) { + knownLength += this._lastBoundary().length; + } -var implementation = __webpack_require__("../../node_modules/function-bind/implementation.js"); + if (!this._valuesToMeasure.length) { + process.nextTick(cb.bind(this, null, knownLength)); + return; + } -module.exports = Function.prototype.bind || implementation; + asynckit.parallel(this._valuesToMeasure, this._lengthRetriever, function(err, values) { + if (err) { + cb(err); + return; + } + values.forEach(function(length) { + knownLength += length; + }); -/***/ }), + cb(null, knownLength); + }); +}; -/***/ "../../node_modules/get-stream/buffer-stream.js": -/***/ (function(module, exports, __webpack_require__) { +FormData.prototype.submit = function(params, cb) { + var request + , options + , defaults = {method: 'post'} + ; -"use strict"; + // parse provided url if it's string + // or treat it as options object + if (typeof params == 'string') { -const {PassThrough: PassThroughStream} = __webpack_require__("stream"); + params = parseUrl(params); + options = populate({ + port: params.port, + path: params.pathname, + host: params.hostname, + protocol: params.protocol + }, defaults); -module.exports = options => { - options = {...options}; + // use custom params + } else { - const {array} = options; - let {encoding} = options; - const isBuffer = encoding === 'buffer'; - let objectMode = false; + options = populate(params, defaults); + // if no port provided use default one + if (!options.port) { + options.port = options.protocol == 'https:' ? 443 : 80; + } + } - if (array) { - objectMode = !(encoding || isBuffer); - } else { - encoding = encoding || 'utf8'; - } + // put that good code in getHeaders to some use + options.headers = this.getHeaders(params.headers); - if (isBuffer) { - encoding = null; - } + // https if specified, fallback to http in any other case + if (options.protocol == 'https:') { + request = https.request(options); + } else { + request = http.request(options); + } - const stream = new PassThroughStream({objectMode}); + // get content length and fire away + this.getLength(function(err, length) { + if (err && err !== 'Unknown stream') { + this._error(err); + return; + } - if (encoding) { - stream.setEncoding(encoding); - } + // add content length + if (length) { + request.setHeader('Content-Length', length); + } - let length = 0; - const chunks = []; + this.pipe(request); + if (cb) { + var onResponse; - stream.on('data', chunk => { - chunks.push(chunk); + var callback = function (error, responce) { + request.removeListener('error', callback); + request.removeListener('response', onResponse); - if (objectMode) { - length = chunks.length; - } else { - length += chunk.length; - } - }); + return cb.call(this, error, responce); + }; - stream.getBufferedValue = () => { - if (array) { - return chunks; - } + onResponse = callback.bind(this, null); - return isBuffer ? Buffer.concat(chunks, length) : chunks.join(''); - }; + request.on('error', callback); + request.on('response', onResponse); + } + }.bind(this)); - stream.getBufferedLength = () => length; + return request; +}; - return stream; +FormData.prototype._error = function(err) { + if (!this.error) { + this.error = err; + this.pause(); + this.emit('error', err); + } +}; + +FormData.prototype.toString = function () { + return '[object FormData]'; }; /***/ }), -/***/ "../../node_modules/get-stream/index.js": -/***/ (function(module, exports, __webpack_require__) { +/***/ "../../node_modules/form-data/lib/populate.js": +/***/ (function(module, exports) { -"use strict"; +// populates missing values +module.exports = function(dst, src) { -const pump = __webpack_require__("../../node_modules/pump/index.js"); -const bufferStream = __webpack_require__("../../node_modules/get-stream/buffer-stream.js"); + Object.keys(src).forEach(function(prop) + { + dst[prop] = dst[prop] || src[prop]; + }); -class MaxBufferError extends Error { - constructor() { - super('maxBuffer exceeded'); - this.name = 'MaxBufferError'; - } -} + return dst; +}; -async function getStream(inputStream, options) { - if (!inputStream) { - return Promise.reject(new Error('Expected a stream')); - } - options = { - maxBuffer: Infinity, - ...options - }; +/***/ }), - const {maxBuffer} = options; +/***/ "../../node_modules/fs.realpath/index.js": +/***/ (function(module, exports, __webpack_require__) { - let stream; - await new Promise((resolve, reject) => { - const rejectPromise = error => { - if (error) { // A null check - error.bufferedData = stream.getBufferedValue(); - } +module.exports = realpath +realpath.realpath = realpath +realpath.sync = realpathSync +realpath.realpathSync = realpathSync +realpath.monkeypatch = monkeypatch +realpath.unmonkeypatch = unmonkeypatch - reject(error); - }; +var fs = __webpack_require__("fs") +var origRealpath = fs.realpath +var origRealpathSync = fs.realpathSync - stream = pump(inputStream, bufferStream(options), error => { - if (error) { - rejectPromise(error); - return; - } +var version = process.version +var ok = /^v[0-5]\./.test(version) +var old = __webpack_require__("../../node_modules/fs.realpath/old.js") - resolve(); - }); +function newError (er) { + return er && er.syscall === 'realpath' && ( + er.code === 'ELOOP' || + er.code === 'ENOMEM' || + er.code === 'ENAMETOOLONG' + ) +} - stream.on('data', () => { - if (stream.getBufferedLength() > maxBuffer) { - rejectPromise(new MaxBufferError()); - } - }); - }); +function realpath (p, cache, cb) { + if (ok) { + return origRealpath(p, cache, cb) + } - return stream.getBufferedValue(); + if (typeof cache === 'function') { + cb = cache + cache = null + } + origRealpath(p, cache, function (er, result) { + if (newError(er)) { + old.realpath(p, cache, cb) + } else { + cb(er, result) + } + }) } -module.exports = getStream; -// TODO: Remove this for the next major release -module.exports.default = getStream; -module.exports.buffer = (stream, options) => getStream(stream, {...options, encoding: 'buffer'}); -module.exports.array = (stream, options) => getStream(stream, {...options, array: true}); -module.exports.MaxBufferError = MaxBufferError; +function realpathSync (p, cache) { + if (ok) { + return origRealpathSync(p, cache) + } + + try { + return origRealpathSync(p, cache) + } catch (er) { + if (newError(er)) { + return old.realpathSync(p, cache) + } else { + throw er + } + } +} + +function monkeypatch () { + fs.realpath = realpath + fs.realpathSync = realpathSync +} + +function unmonkeypatch () { + fs.realpath = origRealpath + fs.realpathSync = origRealpathSync +} /***/ }), -/***/ "../../node_modules/getopts/index.js": +/***/ "../../node_modules/fs.realpath/old.js": /***/ (function(module, exports, __webpack_require__) { -"use strict"; +// Copyright Joyent, Inc. and other Node contributors. +// +// Permission is hereby granted, free of charge, to any person obtaining a +// copy of this software and associated documentation files (the +// "Software"), to deal in the Software without restriction, including +// without limitation the rights to use, copy, modify, merge, publish, +// distribute, sublicense, and/or sell copies of the Software, and to permit +// persons to whom the Software is furnished to do so, subject to the +// following conditions: +// +// The above copyright notice and this permission notice shall be included +// in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN +// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, +// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE +// USE OR OTHER DEALINGS IN THE SOFTWARE. +var pathModule = __webpack_require__("path"); +var isWindows = process.platform === 'win32'; +var fs = __webpack_require__("fs"); -const EMPTYARR = [] -const SHORTSPLIT = /$|[!-@[-`{-~][\s\S]*/g -const isArray = Array.isArray +// JavaScript implementation of realpath, ported from node pre-v6 -const parseValue = function(any) { - if (any === "") return "" - if (any === "false") return false - const maybe = Number(any) - return maybe * 0 === 0 ? maybe : any -} +var DEBUG = process.env.NODE_DEBUG && /fs/.test(process.env.NODE_DEBUG); -const parseAlias = function(aliases) { - let out = {}, - key, - alias, - prev, - len, - any, - i, - k +function rethrow() { + // Only enable in debug mode. A backtrace uses ~1000 bytes of heap space and + // is fairly slow to generate. + var callback; + if (DEBUG) { + var backtrace = new Error; + callback = debugCallback; + } else + callback = missingCallback; - for (key in aliases) { - any = aliases[key] - alias = out[key] = isArray(any) ? any : [any] + return callback; - for (i = 0, len = alias.length; i < len; i++) { - prev = out[alias[i]] = [key] + function debugCallback(err) { + if (err) { + backtrace.message = err.message; + err = backtrace; + missingCallback(err); + } + } - for (k = 0; k < len; k++) { - if (i !== k) prev.push(alias[k]) + function missingCallback(err) { + if (err) { + if (process.throwDeprecation) + throw err; // Forgot a callback but don't know where? Use NODE_DEBUG=fs + else if (!process.noDeprecation) { + var msg = 'fs: missing callback ' + (err.stack || err.message); + if (process.traceDeprecation) + console.trace(msg); + else + console.error(msg); } } } - - return out } -const parseDefault = function(aliases, defaults) { - let out = {}, - key, - alias, - value, - len, - i - - for (key in defaults) { - value = defaults[key] - alias = aliases[key] +function maybeCallback(cb) { + return typeof cb === 'function' ? cb : rethrow(); +} - out[key] = value +var normalize = pathModule.normalize; - if (alias === undefined) { - aliases[key] = EMPTYARR - } else { - for (i = 0, len = alias.length; i < len; i++) { - out[alias[i]] = value - } - } - } +// Regexp that finds the next partion of a (partial) path +// result is [base_with_slash, base], e.g. ['somedir/', 'somedir'] +if (isWindows) { + var nextPartRe = /(.*?)(?:[\/\\]+|$)/g; +} else { + var nextPartRe = /(.*?)(?:[\/]+|$)/g; +} - return out +// Regex to find the device root, including trailing slash. E.g. 'c:\\'. +if (isWindows) { + var splitRootRe = /^(?:[a-zA-Z]:|[\\\/]{2}[^\\\/]+[\\\/][^\\\/]+)?[\\\/]*/; +} else { + var splitRootRe = /^[\/]*/; } -const parseOptions = function(aliases, options, value) { - let out = {}, - key, - alias, - len, - end, - i, - k +exports.realpathSync = function realpathSync(p, cache) { + // make p is absolute + p = pathModule.resolve(p); - if (options !== undefined) { - for (i = 0, len = options.length; i < len; i++) { - key = options[i] - alias = aliases[key] + if (cache && Object.prototype.hasOwnProperty.call(cache, p)) { + return cache[p]; + } - out[key] = value + var original = p, + seenLinks = {}, + knownHard = {}; - if (alias === undefined) { - aliases[key] = EMPTYARR - } else { - for (k = 0, end = alias.length; k < end; k++) { - out[alias[k]] = value - } - } - } - } + // current character position in p + var pos; + // the partial path so far, including a trailing slash if any + var current; + // the partial path without a trailing slash (except when pointing at a root) + var base; + // the partial path scanned in the previous round, with slash + var previous; - return out -} + start(); -const write = function(out, key, value, aliases, unknown) { - let i, - prev, - alias = aliases[key], - len = alias === undefined ? -1 : alias.length - - if (len >= 0 || unknown === undefined || unknown(key)) { - prev = out[key] - - if (prev === undefined) { - out[key] = value - } else { - if (isArray(prev)) { - prev.push(value) - } else { - out[key] = [prev, value] - } - } + function start() { + // Skip over roots + var m = splitRootRe.exec(p); + pos = m[0].length; + current = m[0]; + base = m[0]; + previous = ''; - for (i = 0; i < len; i++) { - out[alias[i]] = out[key] + // On windows, check that the root exists. On unix there is no need. + if (isWindows && !knownHard[base]) { + fs.lstatSync(base); + knownHard[base] = true; } } -} -const getopts = function(argv, opts) { - let unknown = (opts = opts || {}).unknown, - aliases = parseAlias(opts.alias), - strings = parseOptions(aliases, opts.string, ""), - values = parseDefault(aliases, opts.default), - bools = parseOptions(aliases, opts.boolean, false), - stopEarly = opts.stopEarly, - _ = [], - out = { _ }, - i = 0, - k = 0, - len = argv.length, - key, - arg, - end, - match, - value + // walk down the path, swapping out linked pathparts for their real + // values + // NB: p.length changes. + while (pos < p.length) { + // find the next part + nextPartRe.lastIndex = pos; + var result = nextPartRe.exec(p); + previous = current; + current += result[0]; + base = previous + result[1]; + pos = nextPartRe.lastIndex; - for (; i < len; i++) { - arg = argv[i] + // continue if not a symlink + if (knownHard[base] || (cache && cache[base] === base)) { + continue; + } - if (arg[0] !== "-" || arg === "-") { - if (stopEarly) while (i < len) _.push(argv[i++]) - else _.push(arg) - } else if (arg === "--") { - while (++i < len) _.push(argv[i]) - } else if (arg[1] === "-") { - end = arg.indexOf("=", 2) - if (arg[2] === "n" && arg[3] === "o" && arg[4] === "-") { - key = arg.slice(5, end >= 0 ? end : undefined) - value = false - } else if (end >= 0) { - key = arg.slice(2, end) - value = - bools[key] !== undefined || - (strings[key] === undefined - ? parseValue(arg.slice(end + 1)) - : arg.slice(end + 1)) - } else { - key = arg.slice(2) - value = - bools[key] !== undefined || - (len === i + 1 || argv[i + 1][0] === "-" - ? strings[key] === undefined - ? true - : "" - : strings[key] === undefined - ? parseValue(argv[++i]) - : argv[++i]) - } - write(out, key, value, aliases, unknown) + var resolvedLink; + if (cache && Object.prototype.hasOwnProperty.call(cache, base)) { + // some known symbolic link. no need to stat again. + resolvedLink = cache[base]; } else { - SHORTSPLIT.lastIndex = 2 - match = SHORTSPLIT.exec(arg) - end = match.index - value = match[0] + var stat = fs.lstatSync(base); + if (!stat.isSymbolicLink()) { + knownHard[base] = true; + if (cache) cache[base] = base; + continue; + } - for (k = 1; k < end; k++) { - write( - out, - (key = arg[k]), - k + 1 < end - ? strings[key] === undefined || - arg.substring(k + 1, (k = end)) + value - : value === "" - ? len === i + 1 || argv[i + 1][0] === "-" - ? strings[key] === undefined || "" - : bools[key] !== undefined || - (strings[key] === undefined ? parseValue(argv[++i]) : argv[++i]) - : bools[key] !== undefined || - (strings[key] === undefined ? parseValue(value) : value), - aliases, - unknown - ) + // read the link if it wasn't read before + // dev/ino always return 0 on windows, so skip the check. + var linkTarget = null; + if (!isWindows) { + var id = stat.dev.toString(32) + ':' + stat.ino.toString(32); + if (seenLinks.hasOwnProperty(id)) { + linkTarget = seenLinks[id]; + } + } + if (linkTarget === null) { + fs.statSync(base); + linkTarget = fs.readlinkSync(base); } + resolvedLink = pathModule.resolve(previous, linkTarget); + // track this, if given a cache. + if (cache) cache[base] = resolvedLink; + if (!isWindows) seenLinks[id] = linkTarget; } + + // resolve the link, then start over + p = pathModule.resolve(resolvedLink, p.slice(pos)); + start(); } - for (key in values) if (out[key] === undefined) out[key] = values[key] - for (key in bools) if (out[key] === undefined) out[key] = false - for (key in strings) if (out[key] === undefined) out[key] = "" + if (cache) cache[original] = p; - return out -} + return p; +}; -module.exports = getopts +exports.realpath = function realpath(p, cache, cb) { + if (typeof cb !== 'function') { + cb = maybeCallback(cache); + cache = null; + } -/***/ }), + // make p is absolute + p = pathModule.resolve(p); -/***/ "../../node_modules/git-hooks-list/index.json": -/***/ (function(module) { + if (cache && Object.prototype.hasOwnProperty.call(cache, p)) { + return process.nextTick(cb.bind(null, null, cache[p])); + } -module.exports = JSON.parse("[\"applypatch-msg\",\"pre-applypatch\",\"post-applypatch\",\"pre-commit\",\"pre-merge-commit\",\"prepare-commit-msg\",\"commit-msg\",\"post-commit\",\"pre-rebase\",\"post-checkout\",\"post-merge\",\"pre-push\",\"pre-receive\",\"update\",\"post-receive\",\"post-update\",\"push-to-checkout\",\"pre-auto-gc\",\"post-rewrite\",\"sendemail-validate\",\"fsmonitor-watchman\",\"p4-pre-submit\",\"post-index-change\"]"); + var original = p, + seenLinks = {}, + knownHard = {}; -/***/ }), + // current character position in p + var pos; + // the partial path so far, including a trailing slash if any + var current; + // the partial path without a trailing slash (except when pointing at a root) + var base; + // the partial path scanned in the previous round, with slash + var previous; -/***/ "../../node_modules/glob-parent/index.js": -/***/ (function(module, exports, __webpack_require__) { + start(); -"use strict"; + function start() { + // Skip over roots + var m = splitRootRe.exec(p); + pos = m[0].length; + current = m[0]; + base = m[0]; + previous = ''; + // On windows, check that the root exists. On unix there is no need. + if (isWindows && !knownHard[base]) { + fs.lstat(base, function(err) { + if (err) return cb(err); + knownHard[base] = true; + LOOP(); + }); + } else { + process.nextTick(LOOP); + } + } -var isGlob = __webpack_require__("../../node_modules/is-glob/index.js"); -var pathPosixDirname = __webpack_require__("path").posix.dirname; -var isWin32 = __webpack_require__("os").platform() === 'win32'; + // walk down the path, swapping out linked pathparts for their real + // values + function LOOP() { + // stop if scanned past end of path + if (pos >= p.length) { + if (cache) cache[original] = p; + return cb(null, p); + } -var slash = '/'; -var backslash = /\\/g; -var enclosure = /[\{\[].*[\}\]]$/; -var globby = /(^|[^\\])([\{\[]|\([^\)]+$)/; -var escaped = /\\([\!\*\?\|\[\]\(\)\{\}])/g; + // find the next part + nextPartRe.lastIndex = pos; + var result = nextPartRe.exec(p); + previous = current; + current += result[0]; + base = previous + result[1]; + pos = nextPartRe.lastIndex; -/** - * @param {string} str - * @param {Object} opts - * @param {boolean} [opts.flipBackslashes=true] - * @returns {string} - */ -module.exports = function globParent(str, opts) { - var options = Object.assign({ flipBackslashes: true }, opts); + // continue if not a symlink + if (knownHard[base] || (cache && cache[base] === base)) { + return process.nextTick(LOOP); + } - // flip windows path separators - if (options.flipBackslashes && isWin32 && str.indexOf(slash) < 0) { - str = str.replace(backslash, slash); - } + if (cache && Object.prototype.hasOwnProperty.call(cache, base)) { + // known symbolic link. no need to stat again. + return gotResolvedLink(cache[base]); + } - // special case for strings ending in enclosure containing path separator - if (enclosure.test(str)) { - str += slash; + return fs.lstat(base, gotStat); } - // preserves full path in case of trailing path separator - str += 'a'; + function gotStat(err, stat) { + if (err) return cb(err); - // remove path parts that are globby - do { - str = pathPosixDirname(str); - } while (isGlob(str) || globby.test(str)); + // if not a symlink, skip to the next path part + if (!stat.isSymbolicLink()) { + knownHard[base] = true; + if (cache) cache[base] = base; + return process.nextTick(LOOP); + } - // remove escape chars and return result - return str.replace(escaped, '$1'); + // stat & read the link if not read before + // call gotTarget as soon as the link target is known + // dev/ino always return 0 on windows, so skip the check. + if (!isWindows) { + var id = stat.dev.toString(32) + ':' + stat.ino.toString(32); + if (seenLinks.hasOwnProperty(id)) { + return gotTarget(null, seenLinks[id], base); + } + } + fs.stat(base, function(err) { + if (err) return cb(err); + + fs.readlink(base, function(err, target) { + if (!isWindows) seenLinks[id] = target; + gotTarget(err, target); + }); + }); + } + + function gotTarget(err, target, base) { + if (err) return cb(err); + + var resolvedLink = pathModule.resolve(previous, target); + if (cache) cache[base] = resolvedLink; + gotResolvedLink(resolvedLink); + } + + function gotResolvedLink(resolvedLink) { + // resolve the link, then start over + p = pathModule.resolve(resolvedLink, p.slice(pos)); + start(); + } }; /***/ }), -/***/ "../../node_modules/glob/common.js": +/***/ "../../node_modules/function-bind/implementation.js": /***/ (function(module, exports, __webpack_require__) { -exports.setopts = setopts -exports.ownProp = ownProp -exports.makeAbs = makeAbs -exports.finish = finish -exports.mark = mark -exports.isIgnored = isIgnored -exports.childrenIgnored = childrenIgnored - -function ownProp (obj, field) { - return Object.prototype.hasOwnProperty.call(obj, field) -} - -var fs = __webpack_require__("fs") -var path = __webpack_require__("path") -var minimatch = __webpack_require__("../../node_modules/minimatch/minimatch.js") -var isAbsolute = __webpack_require__("../../node_modules/path-is-absolute/index.js") -var Minimatch = minimatch.Minimatch +"use strict"; -function alphasort (a, b) { - return a.localeCompare(b, 'en') -} -function setupIgnores (self, options) { - self.ignore = options.ignore || [] +/* eslint no-invalid-this: 1 */ - if (!Array.isArray(self.ignore)) - self.ignore = [self.ignore] +var ERROR_MESSAGE = 'Function.prototype.bind called on incompatible '; +var slice = Array.prototype.slice; +var toStr = Object.prototype.toString; +var funcType = '[object Function]'; - if (self.ignore.length) { - self.ignore = self.ignore.map(ignoreMap) - } -} +module.exports = function bind(that) { + var target = this; + if (typeof target !== 'function' || toStr.call(target) !== funcType) { + throw new TypeError(ERROR_MESSAGE + target); + } + var args = slice.call(arguments, 1); -// ignore patterns are always in dot:true mode. -function ignoreMap (pattern) { - var gmatcher = null - if (pattern.slice(-3) === '/**') { - var gpattern = pattern.replace(/(\/\*\*)+$/, '') - gmatcher = new Minimatch(gpattern, { dot: true }) - } + var bound; + var binder = function () { + if (this instanceof bound) { + var result = target.apply( + this, + args.concat(slice.call(arguments)) + ); + if (Object(result) === result) { + return result; + } + return this; + } else { + return target.apply( + that, + args.concat(slice.call(arguments)) + ); + } + }; - return { - matcher: new Minimatch(pattern, { dot: true }), - gmatcher: gmatcher - } -} + var boundLength = Math.max(0, target.length - args.length); + var boundArgs = []; + for (var i = 0; i < boundLength; i++) { + boundArgs.push('$' + i); + } -function setopts (self, pattern, options) { - if (!options) - options = {} + bound = Function('binder', 'return function (' + boundArgs.join(',') + '){ return binder.apply(this,arguments); }')(binder); - // base-matching: just use globstar for that. - if (options.matchBase && -1 === pattern.indexOf("/")) { - if (options.noglobstar) { - throw new Error("base matching requires globstar") + if (target.prototype) { + var Empty = function Empty() {}; + Empty.prototype = target.prototype; + bound.prototype = new Empty(); + Empty.prototype = null; } - pattern = "**/" + pattern - } - self.silent = !!options.silent - self.pattern = pattern - self.strict = options.strict !== false - self.realpath = !!options.realpath - self.realpathCache = options.realpathCache || Object.create(null) - self.follow = !!options.follow - self.dot = !!options.dot - self.mark = !!options.mark - self.nodir = !!options.nodir - if (self.nodir) - self.mark = true - self.sync = !!options.sync - self.nounique = !!options.nounique - self.nonull = !!options.nonull - self.nosort = !!options.nosort - self.nocase = !!options.nocase - self.stat = !!options.stat - self.noprocess = !!options.noprocess - self.absolute = !!options.absolute - self.fs = options.fs || fs + return bound; +}; - self.maxLength = options.maxLength || Infinity - self.cache = options.cache || Object.create(null) - self.statCache = options.statCache || Object.create(null) - self.symlinks = options.symlinks || Object.create(null) - setupIgnores(self, options) +/***/ }), - self.changedCwd = false - var cwd = process.cwd() - if (!ownProp(options, "cwd")) - self.cwd = cwd - else { - self.cwd = path.resolve(options.cwd) - self.changedCwd = self.cwd !== cwd - } +/***/ "../../node_modules/function-bind/index.js": +/***/ (function(module, exports, __webpack_require__) { - self.root = options.root || path.resolve(self.cwd, "/") - self.root = path.resolve(self.root) - if (process.platform === "win32") - self.root = self.root.replace(/\\/g, "/") +"use strict"; - // TODO: is an absolute `cwd` supposed to be resolved against `root`? - // e.g. { cwd: '/test', root: __dirname } === path.join(__dirname, '/test') - self.cwdAbs = isAbsolute(self.cwd) ? self.cwd : makeAbs(self, self.cwd) - if (process.platform === "win32") - self.cwdAbs = self.cwdAbs.replace(/\\/g, "/") - self.nomount = !!options.nomount - // disable comments and negation in Minimatch. - // Note that they are not supported in Glob itself anyway. - options.nonegate = true - options.nocomment = true +var implementation = __webpack_require__("../../node_modules/function-bind/implementation.js"); - self.minimatch = new Minimatch(pattern, options) - self.options = self.minimatch.options -} +module.exports = Function.prototype.bind || implementation; -function finish (self) { - var nou = self.nounique - var all = nou ? [] : Object.create(null) - for (var i = 0, l = self.matches.length; i < l; i ++) { - var matches = self.matches[i] - if (!matches || Object.keys(matches).length === 0) { - if (self.nonull) { - // do like the shell, and spit out the literal glob - var literal = self.minimatch.globSet[i] - if (nou) - all.push(literal) - else - all[literal] = true - } - } else { - // had matches - var m = Object.keys(matches) - if (nou) - all.push.apply(all, m) - else - m.forEach(function (m) { - all[m] = true - }) - } - } +/***/ }), - if (!nou) - all = Object.keys(all) +/***/ "../../node_modules/get-stream/buffer-stream.js": +/***/ (function(module, exports, __webpack_require__) { - if (!self.nosort) - all = all.sort(alphasort) +"use strict"; - // at *some* point we statted all of these - if (self.mark) { - for (var i = 0; i < all.length; i++) { - all[i] = self._mark(all[i]) - } - if (self.nodir) { - all = all.filter(function (e) { - var notDir = !(/\/$/.test(e)) - var c = self.cache[e] || self.cache[makeAbs(self, e)] - if (notDir && c) - notDir = c !== 'DIR' && !Array.isArray(c) - return notDir - }) - } - } +const {PassThrough: PassThroughStream} = __webpack_require__("stream"); - if (self.ignore.length) - all = all.filter(function(m) { - return !isIgnored(self, m) - }) +module.exports = options => { + options = {...options}; - self.found = all -} + const {array} = options; + let {encoding} = options; + const isBuffer = encoding === 'buffer'; + let objectMode = false; -function mark (self, p) { - var abs = makeAbs(self, p) - var c = self.cache[abs] - var m = p - if (c) { - var isDir = c === 'DIR' || Array.isArray(c) - var slash = p.slice(-1) === '/' - - if (isDir && !slash) - m += '/' - else if (!isDir && slash) - m = m.slice(0, -1) + if (array) { + objectMode = !(encoding || isBuffer); + } else { + encoding = encoding || 'utf8'; + } - if (m !== p) { - var mabs = makeAbs(self, m) - self.statCache[mabs] = self.statCache[abs] - self.cache[mabs] = self.cache[abs] - } - } + if (isBuffer) { + encoding = null; + } - return m -} + const stream = new PassThroughStream({objectMode}); -// lotta situps... -function makeAbs (self, f) { - var abs = f - if (f.charAt(0) === '/') { - abs = path.join(self.root, f) - } else if (isAbsolute(f) || f === '') { - abs = f - } else if (self.changedCwd) { - abs = path.resolve(self.cwd, f) - } else { - abs = path.resolve(f) - } + if (encoding) { + stream.setEncoding(encoding); + } - if (process.platform === 'win32') - abs = abs.replace(/\\/g, '/') + let length = 0; + const chunks = []; - return abs -} + stream.on('data', chunk => { + chunks.push(chunk); + if (objectMode) { + length = chunks.length; + } else { + length += chunk.length; + } + }); -// Return true, if pattern ends with globstar '**', for the accompanying parent directory. -// Ex:- If node_modules/** is the pattern, add 'node_modules' to ignore list along with it's contents -function isIgnored (self, path) { - if (!self.ignore.length) - return false + stream.getBufferedValue = () => { + if (array) { + return chunks; + } - return self.ignore.some(function(item) { - return item.matcher.match(path) || !!(item.gmatcher && item.gmatcher.match(path)) - }) -} + return isBuffer ? Buffer.concat(chunks, length) : chunks.join(''); + }; -function childrenIgnored (self, path) { - if (!self.ignore.length) - return false + stream.getBufferedLength = () => length; - return self.ignore.some(function(item) { - return !!(item.gmatcher && item.gmatcher.match(path)) - }) -} + return stream; +}; /***/ }), -/***/ "../../node_modules/glob/glob.js": +/***/ "../../node_modules/get-stream/index.js": /***/ (function(module, exports, __webpack_require__) { -// Approach: -// -// 1. Get the minimatch set -// 2. For each pattern in the set, PROCESS(pattern, false) -// 3. Store matches per-set, then uniq them -// -// PROCESS(pattern, inGlobStar) -// Get the first [n] items from pattern that are all strings -// Join these together. This is PREFIX. -// If there is no more remaining, then stat(PREFIX) and -// add to matches if it succeeds. END. -// -// If inGlobStar and PREFIX is symlink and points to dir -// set ENTRIES = [] -// else readdir(PREFIX) as ENTRIES -// If fail, END -// -// with ENTRIES -// If pattern[n] is GLOBSTAR -// // handle the case where the globstar match is empty -// // by pruning it out, and testing the resulting pattern -// PROCESS(pattern[0..n] + pattern[n+1 .. $], false) -// // handle other cases. -// for ENTRY in ENTRIES (not dotfiles) -// // attach globstar + tail onto the entry -// // Mark that this entry is a globstar match -// PROCESS(pattern[0..n] + ENTRY + pattern[n .. $], true) -// -// else // not globstar -// for ENTRY in ENTRIES (not dotfiles, unless pattern[n] is dot) -// Test ENTRY against pattern[n] -// If fails, continue -// If passes, PROCESS(pattern[0..n] + item + pattern[n+1 .. $]) -// -// Caveat: -// Cache all stats and readdirs results to minimize syscall. Since all -// we ever care about is existence and directory-ness, we can just keep -// `true` for files, and [children,...] for directories, or `false` for -// things that don't exist. - -module.exports = glob - -var rp = __webpack_require__("../../node_modules/fs.realpath/index.js") -var minimatch = __webpack_require__("../../node_modules/minimatch/minimatch.js") -var Minimatch = minimatch.Minimatch -var inherits = __webpack_require__("../../node_modules/inherits/inherits.js") -var EE = __webpack_require__("events").EventEmitter -var path = __webpack_require__("path") -var assert = __webpack_require__("assert") -var isAbsolute = __webpack_require__("../../node_modules/path-is-absolute/index.js") -var globSync = __webpack_require__("../../node_modules/glob/sync.js") -var common = __webpack_require__("../../node_modules/glob/common.js") -var setopts = common.setopts -var ownProp = common.ownProp -var inflight = __webpack_require__("../../node_modules/inflight/inflight.js") -var util = __webpack_require__("util") -var childrenIgnored = common.childrenIgnored -var isIgnored = common.isIgnored - -var once = __webpack_require__("../../node_modules/once/once.js") - -function glob (pattern, options, cb) { - if (typeof options === 'function') cb = options, options = {} - if (!options) options = {} +"use strict"; - if (options.sync) { - if (cb) - throw new TypeError('callback provided to sync glob') - return globSync(pattern, options) - } +const pump = __webpack_require__("../../node_modules/pump/index.js"); +const bufferStream = __webpack_require__("../../node_modules/get-stream/buffer-stream.js"); - return new Glob(pattern, options, cb) +class MaxBufferError extends Error { + constructor() { + super('maxBuffer exceeded'); + this.name = 'MaxBufferError'; + } } -glob.sync = globSync -var GlobSync = glob.GlobSync = globSync.GlobSync - -// old api surface -glob.glob = glob +async function getStream(inputStream, options) { + if (!inputStream) { + return Promise.reject(new Error('Expected a stream')); + } -function extend (origin, add) { - if (add === null || typeof add !== 'object') { - return origin - } + options = { + maxBuffer: Infinity, + ...options + }; - var keys = Object.keys(add) - var i = keys.length - while (i--) { - origin[keys[i]] = add[keys[i]] - } - return origin -} + const {maxBuffer} = options; -glob.hasMagic = function (pattern, options_) { - var options = extend({}, options_) - options.noprocess = true + let stream; + await new Promise((resolve, reject) => { + const rejectPromise = error => { + if (error) { // A null check + error.bufferedData = stream.getBufferedValue(); + } - var g = new Glob(pattern, options) - var set = g.minimatch.set + reject(error); + }; - if (!pattern) - return false + stream = pump(inputStream, bufferStream(options), error => { + if (error) { + rejectPromise(error); + return; + } - if (set.length > 1) - return true + resolve(); + }); - for (var j = 0; j < set[0].length; j++) { - if (typeof set[0][j] !== 'string') - return true - } + stream.on('data', () => { + if (stream.getBufferedLength() > maxBuffer) { + rejectPromise(new MaxBufferError()); + } + }); + }); - return false + return stream.getBufferedValue(); } -glob.Glob = Glob -inherits(Glob, EE) -function Glob (pattern, options, cb) { - if (typeof options === 'function') { - cb = options - options = null - } +module.exports = getStream; +// TODO: Remove this for the next major release +module.exports.default = getStream; +module.exports.buffer = (stream, options) => getStream(stream, {...options, encoding: 'buffer'}); +module.exports.array = (stream, options) => getStream(stream, {...options, array: true}); +module.exports.MaxBufferError = MaxBufferError; - if (options && options.sync) { - if (cb) - throw new TypeError('callback provided to sync glob') - return new GlobSync(pattern, options) - } - if (!(this instanceof Glob)) - return new Glob(pattern, options, cb) +/***/ }), - setopts(this, pattern, options) - this._didRealPath = false +/***/ "../../node_modules/getopts/index.js": +/***/ (function(module, exports, __webpack_require__) { - // process each pattern in the minimatch set - var n = this.minimatch.set.length +"use strict"; - // The matches are stored as {: true,...} so that - // duplicates are automagically pruned. - // Later, we do an Object.keys() on these. - // Keep them as a list so we can fill in when nonull is set. - this.matches = new Array(n) - if (typeof cb === 'function') { - cb = once(cb) - this.on('error', cb) - this.on('end', function (matches) { - cb(null, matches) - }) - } - - var self = this - this._processing = 0 +const EMPTYARR = [] +const SHORTSPLIT = /$|[!-@[-`{-~][\s\S]*/g +const isArray = Array.isArray - this._emitQueue = [] - this._processQueue = [] - this.paused = false +const parseValue = function(any) { + if (any === "") return "" + if (any === "false") return false + const maybe = Number(any) + return maybe * 0 === 0 ? maybe : any +} - if (this.noprocess) - return this +const parseAlias = function(aliases) { + let out = {}, + key, + alias, + prev, + len, + any, + i, + k - if (n === 0) - return done() + for (key in aliases) { + any = aliases[key] + alias = out[key] = isArray(any) ? any : [any] - var sync = true - for (var i = 0; i < n; i ++) { - this._process(this.minimatch.set[i], i, false, done) - } - sync = false + for (i = 0, len = alias.length; i < len; i++) { + prev = out[alias[i]] = [key] - function done () { - --self._processing - if (self._processing <= 0) { - if (sync) { - process.nextTick(function () { - self._finish() - }) - } else { - self._finish() + for (k = 0; k < len; k++) { + if (i !== k) prev.push(alias[k]) } } } -} - -Glob.prototype._finish = function () { - assert(this instanceof Glob) - if (this.aborted) - return - - if (this.realpath && !this._didRealpath) - return this._realpath() - common.finish(this) - this.emit('end', this.found) + return out } -Glob.prototype._realpath = function () { - if (this._didRealpath) - return - - this._didRealpath = true +const parseDefault = function(aliases, defaults) { + let out = {}, + key, + alias, + value, + len, + i - var n = this.matches.length - if (n === 0) - return this._finish() + for (key in defaults) { + value = defaults[key] + alias = aliases[key] - var self = this - for (var i = 0; i < this.matches.length; i++) - this._realpathSet(i, next) + out[key] = value - function next () { - if (--n === 0) - self._finish() + if (alias === undefined) { + aliases[key] = EMPTYARR + } else { + for (i = 0, len = alias.length; i < len; i++) { + out[alias[i]] = value + } + } } -} -Glob.prototype._realpathSet = function (index, cb) { - var matchset = this.matches[index] - if (!matchset) - return cb() + return out +} - var found = Object.keys(matchset) - var self = this - var n = found.length +const parseOptions = function(aliases, options, value) { + let out = {}, + key, + alias, + len, + end, + i, + k - if (n === 0) - return cb() + if (options !== undefined) { + for (i = 0, len = options.length; i < len; i++) { + key = options[i] + alias = aliases[key] - var set = this.matches[index] = Object.create(null) - found.forEach(function (p, i) { - // If there's a problem with the stat, then it means that - // one or more of the links in the realpath couldn't be - // resolved. just return the abs value in that case. - p = self._makeAbs(p) - rp.realpath(p, self.realpathCache, function (er, real) { - if (!er) - set[real] = true - else if (er.syscall === 'stat') - set[p] = true - else - self.emit('error', er) // srsly wtf right here + out[key] = value - if (--n === 0) { - self.matches[index] = set - cb() + if (alias === undefined) { + aliases[key] = EMPTYARR + } else { + for (k = 0, end = alias.length; k < end; k++) { + out[alias[k]] = value + } } - }) - }) -} - -Glob.prototype._mark = function (p) { - return common.mark(this, p) -} + } + } -Glob.prototype._makeAbs = function (f) { - return common.makeAbs(this, f) + return out } -Glob.prototype.abort = function () { - this.aborted = true - this.emit('abort') -} +const write = function(out, key, value, aliases, unknown) { + let i, + prev, + alias = aliases[key], + len = alias === undefined ? -1 : alias.length -Glob.prototype.pause = function () { - if (!this.paused) { - this.paused = true - this.emit('pause') - } -} + if (len >= 0 || unknown === undefined || unknown(key)) { + prev = out[key] -Glob.prototype.resume = function () { - if (this.paused) { - this.emit('resume') - this.paused = false - if (this._emitQueue.length) { - var eq = this._emitQueue.slice(0) - this._emitQueue.length = 0 - for (var i = 0; i < eq.length; i ++) { - var e = eq[i] - this._emitMatch(e[0], e[1]) + if (prev === undefined) { + out[key] = value + } else { + if (isArray(prev)) { + prev.push(value) + } else { + out[key] = [prev, value] } } - if (this._processQueue.length) { - var pq = this._processQueue.slice(0) - this._processQueue.length = 0 - for (var i = 0; i < pq.length; i ++) { - var p = pq[i] - this._processing-- - this._process(p[0], p[1], p[2], p[3]) - } + + for (i = 0; i < len; i++) { + out[alias[i]] = out[key] } } } -Glob.prototype._process = function (pattern, index, inGlobStar, cb) { - assert(this instanceof Glob) - assert(typeof cb === 'function') - - if (this.aborted) - return - - this._processing++ - if (this.paused) { - this._processQueue.push([pattern, index, inGlobStar, cb]) - return - } - - //console.error('PROCESS %d', this._processing, pattern) - - // Get the first [n] parts of pattern that are all strings. - var n = 0 - while (typeof pattern[n] === 'string') { - n ++ - } - // now n is the index of the first one that is *not* a string. - - // see if there's anything else - var prefix - switch (n) { - // if not, then this is rather simple - case pattern.length: - this._processSimple(pattern.join('/'), index, cb) - return +const getopts = function(argv, opts) { + let unknown = (opts = opts || {}).unknown, + aliases = parseAlias(opts.alias), + strings = parseOptions(aliases, opts.string, ""), + values = parseDefault(aliases, opts.default), + bools = parseOptions(aliases, opts.boolean, false), + stopEarly = opts.stopEarly, + _ = [], + out = { _ }, + i = 0, + k = 0, + len = argv.length, + key, + arg, + end, + match, + value - case 0: - // pattern *starts* with some non-trivial item. - // going to readdir(cwd), but not include the prefix in matches. - prefix = null - break + for (; i < len; i++) { + arg = argv[i] - default: - // pattern has some string bits in the front. - // whatever it starts with, whether that's 'absolute' like /foo/bar, - // or 'relative' like '../baz' - prefix = pattern.slice(0, n).join('/') - break - } + if (arg[0] !== "-" || arg === "-") { + if (stopEarly) while (i < len) _.push(argv[i++]) + else _.push(arg) + } else if (arg === "--") { + while (++i < len) _.push(argv[i]) + } else if (arg[1] === "-") { + end = arg.indexOf("=", 2) + if (arg[2] === "n" && arg[3] === "o" && arg[4] === "-") { + key = arg.slice(5, end >= 0 ? end : undefined) + value = false + } else if (end >= 0) { + key = arg.slice(2, end) + value = + bools[key] !== undefined || + (strings[key] === undefined + ? parseValue(arg.slice(end + 1)) + : arg.slice(end + 1)) + } else { + key = arg.slice(2) + value = + bools[key] !== undefined || + (len === i + 1 || argv[i + 1][0] === "-" + ? strings[key] === undefined + ? true + : "" + : strings[key] === undefined + ? parseValue(argv[++i]) + : argv[++i]) + } + write(out, key, value, aliases, unknown) + } else { + SHORTSPLIT.lastIndex = 2 + match = SHORTSPLIT.exec(arg) + end = match.index + value = match[0] - var remain = pattern.slice(n) + for (k = 1; k < end; k++) { + write( + out, + (key = arg[k]), + k + 1 < end + ? strings[key] === undefined || + arg.substring(k + 1, (k = end)) + value + : value === "" + ? len === i + 1 || argv[i + 1][0] === "-" + ? strings[key] === undefined || "" + : bools[key] !== undefined || + (strings[key] === undefined ? parseValue(argv[++i]) : argv[++i]) + : bools[key] !== undefined || + (strings[key] === undefined ? parseValue(value) : value), + aliases, + unknown + ) + } + } + } - // get the list of entries. - var read - if (prefix === null) - read = '.' - else if (isAbsolute(prefix) || isAbsolute(pattern.join('/'))) { - if (!prefix || !isAbsolute(prefix)) - prefix = '/' + prefix - read = prefix - } else - read = prefix + for (key in values) if (out[key] === undefined) out[key] = values[key] + for (key in bools) if (out[key] === undefined) out[key] = false + for (key in strings) if (out[key] === undefined) out[key] = "" - var abs = this._makeAbs(read) + return out +} - //if ignored, skip _processing - if (childrenIgnored(this, read)) - return cb() +module.exports = getopts - var isGlobStar = remain[0] === minimatch.GLOBSTAR - if (isGlobStar) - this._processGlobStar(prefix, read, abs, remain, index, inGlobStar, cb) - else - this._processReaddir(prefix, read, abs, remain, index, inGlobStar, cb) -} -Glob.prototype._processReaddir = function (prefix, read, abs, remain, index, inGlobStar, cb) { - var self = this - this._readdir(abs, inGlobStar, function (er, entries) { - return self._processReaddir2(prefix, read, abs, remain, index, inGlobStar, entries, cb) - }) -} +/***/ }), -Glob.prototype._processReaddir2 = function (prefix, read, abs, remain, index, inGlobStar, entries, cb) { +/***/ "../../node_modules/git-hooks-list/index.json": +/***/ (function(module) { - // if the abs isn't a dir, then nothing can match! - if (!entries) - return cb() +module.exports = JSON.parse("[\"applypatch-msg\",\"pre-applypatch\",\"post-applypatch\",\"pre-commit\",\"pre-merge-commit\",\"prepare-commit-msg\",\"commit-msg\",\"post-commit\",\"pre-rebase\",\"post-checkout\",\"post-merge\",\"pre-push\",\"pre-receive\",\"update\",\"post-receive\",\"post-update\",\"push-to-checkout\",\"pre-auto-gc\",\"post-rewrite\",\"sendemail-validate\",\"fsmonitor-watchman\",\"p4-pre-submit\",\"post-index-change\"]"); - // It will only match dot entries if it starts with a dot, or if - // dot is set. Stuff like @(.foo|.bar) isn't allowed. - var pn = remain[0] - var negate = !!this.minimatch.negate - var rawGlob = pn._glob - var dotOk = this.dot || rawGlob.charAt(0) === '.' +/***/ }), - var matchedEntries = [] - for (var i = 0; i < entries.length; i++) { - var e = entries[i] - if (e.charAt(0) !== '.' || dotOk) { - var m - if (negate && !prefix) { - m = !e.match(pn) - } else { - m = e.match(pn) - } - if (m) - matchedEntries.push(e) - } - } +/***/ "../../node_modules/glob-parent/index.js": +/***/ (function(module, exports, __webpack_require__) { - //console.error('prd2', prefix, entries, remain[0]._glob, matchedEntries) +"use strict"; - var len = matchedEntries.length - // If there are no matched entries, then nothing matches. - if (len === 0) - return cb() - // if this is the last remaining pattern bit, then no need for - // an additional stat *unless* the user has specified mark or - // stat explicitly. We know they exist, since readdir returned - // them. +var isGlob = __webpack_require__("../../node_modules/is-glob/index.js"); +var pathPosixDirname = __webpack_require__("path").posix.dirname; +var isWin32 = __webpack_require__("os").platform() === 'win32'; - if (remain.length === 1 && !this.mark && !this.stat) { - if (!this.matches[index]) - this.matches[index] = Object.create(null) +var slash = '/'; +var backslash = /\\/g; +var enclosure = /[\{\[].*[\}\]]$/; +var globby = /(^|[^\\])([\{\[]|\([^\)]+$)/; +var escaped = /\\([\!\*\?\|\[\]\(\)\{\}])/g; - for (var i = 0; i < len; i ++) { - var e = matchedEntries[i] - if (prefix) { - if (prefix !== '/') - e = prefix + '/' + e - else - e = prefix + e - } +/** + * @param {string} str + * @param {Object} opts + * @param {boolean} [opts.flipBackslashes=true] + * @returns {string} + */ +module.exports = function globParent(str, opts) { + var options = Object.assign({ flipBackslashes: true }, opts); - if (e.charAt(0) === '/' && !this.nomount) { - e = path.join(this.root, e) - } - this._emitMatch(index, e) - } - // This was the last one, and no stats were needed - return cb() + // flip windows path separators + if (options.flipBackslashes && isWin32 && str.indexOf(slash) < 0) { + str = str.replace(backslash, slash); } - // now test all matched entries as stand-ins for that part - // of the pattern. - remain.shift() - for (var i = 0; i < len; i ++) { - var e = matchedEntries[i] - var newPattern - if (prefix) { - if (prefix !== '/') - e = prefix + '/' + e - else - e = prefix + e - } - this._process([e].concat(remain), index, inGlobStar, cb) + // special case for strings ending in enclosure containing path separator + if (enclosure.test(str)) { + str += slash; } - cb() -} - -Glob.prototype._emitMatch = function (index, e) { - if (this.aborted) - return - if (isIgnored(this, e)) - return + // preserves full path in case of trailing path separator + str += 'a'; - if (this.paused) { - this._emitQueue.push([index, e]) - return - } + // remove path parts that are globby + do { + str = pathPosixDirname(str); + } while (isGlob(str) || globby.test(str)); - var abs = isAbsolute(e) ? e : this._makeAbs(e) + // remove escape chars and return result + return str.replace(escaped, '$1'); +}; - if (this.mark) - e = this._mark(e) - if (this.absolute) - e = abs +/***/ }), - if (this.matches[index][e]) - return +/***/ "../../node_modules/glob/common.js": +/***/ (function(module, exports, __webpack_require__) { - if (this.nodir) { - var c = this.cache[abs] - if (c === 'DIR' || Array.isArray(c)) - return - } +exports.setopts = setopts +exports.ownProp = ownProp +exports.makeAbs = makeAbs +exports.finish = finish +exports.mark = mark +exports.isIgnored = isIgnored +exports.childrenIgnored = childrenIgnored - this.matches[index][e] = true +function ownProp (obj, field) { + return Object.prototype.hasOwnProperty.call(obj, field) +} - var st = this.statCache[abs] - if (st) - this.emit('stat', e, st) +var fs = __webpack_require__("fs") +var path = __webpack_require__("path") +var minimatch = __webpack_require__("../../node_modules/minimatch/minimatch.js") +var isAbsolute = __webpack_require__("../../node_modules/path-is-absolute/index.js") +var Minimatch = minimatch.Minimatch - this.emit('match', e) +function alphasort (a, b) { + return a.localeCompare(b, 'en') } -Glob.prototype._readdirInGlobStar = function (abs, cb) { - if (this.aborted) - return +function setupIgnores (self, options) { + self.ignore = options.ignore || [] - // follow all symlinked directories forever - // just proceed as if this is a non-globstar situation - if (this.follow) - return this._readdir(abs, false, cb) - - var lstatkey = 'lstat\0' + abs - var self = this - var lstatcb = inflight(lstatkey, lstatcb_) - - if (lstatcb) - self.fs.lstat(abs, lstatcb) + if (!Array.isArray(self.ignore)) + self.ignore = [self.ignore] - function lstatcb_ (er, lstat) { - if (er && er.code === 'ENOENT') - return cb() + if (self.ignore.length) { + self.ignore = self.ignore.map(ignoreMap) + } +} - var isSym = lstat && lstat.isSymbolicLink() - self.symlinks[abs] = isSym +// ignore patterns are always in dot:true mode. +function ignoreMap (pattern) { + var gmatcher = null + if (pattern.slice(-3) === '/**') { + var gpattern = pattern.replace(/(\/\*\*)+$/, '') + gmatcher = new Minimatch(gpattern, { dot: true }) + } - // If it's not a symlink or a dir, then it's definitely a regular file. - // don't bother doing a readdir in that case. - if (!isSym && lstat && !lstat.isDirectory()) { - self.cache[abs] = 'FILE' - cb() - } else - self._readdir(abs, false, cb) + return { + matcher: new Minimatch(pattern, { dot: true }), + gmatcher: gmatcher } } -Glob.prototype._readdir = function (abs, inGlobStar, cb) { - if (this.aborted) - return +function setopts (self, pattern, options) { + if (!options) + options = {} - cb = inflight('readdir\0'+abs+'\0'+inGlobStar, cb) - if (!cb) - return + // base-matching: just use globstar for that. + if (options.matchBase && -1 === pattern.indexOf("/")) { + if (options.noglobstar) { + throw new Error("base matching requires globstar") + } + pattern = "**/" + pattern + } - //console.error('RD %j %j', +inGlobStar, abs) - if (inGlobStar && !ownProp(this.symlinks, abs)) - return this._readdirInGlobStar(abs, cb) + self.silent = !!options.silent + self.pattern = pattern + self.strict = options.strict !== false + self.realpath = !!options.realpath + self.realpathCache = options.realpathCache || Object.create(null) + self.follow = !!options.follow + self.dot = !!options.dot + self.mark = !!options.mark + self.nodir = !!options.nodir + if (self.nodir) + self.mark = true + self.sync = !!options.sync + self.nounique = !!options.nounique + self.nonull = !!options.nonull + self.nosort = !!options.nosort + self.nocase = !!options.nocase + self.stat = !!options.stat + self.noprocess = !!options.noprocess + self.absolute = !!options.absolute + self.fs = options.fs || fs - if (ownProp(this.cache, abs)) { - var c = this.cache[abs] - if (!c || c === 'FILE') - return cb() + self.maxLength = options.maxLength || Infinity + self.cache = options.cache || Object.create(null) + self.statCache = options.statCache || Object.create(null) + self.symlinks = options.symlinks || Object.create(null) - if (Array.isArray(c)) - return cb(null, c) + setupIgnores(self, options) + + self.changedCwd = false + var cwd = process.cwd() + if (!ownProp(options, "cwd")) + self.cwd = cwd + else { + self.cwd = path.resolve(options.cwd) + self.changedCwd = self.cwd !== cwd } - var self = this - self.fs.readdir(abs, readdirCb(this, abs, cb)) -} + self.root = options.root || path.resolve(self.cwd, "/") + self.root = path.resolve(self.root) + if (process.platform === "win32") + self.root = self.root.replace(/\\/g, "/") -function readdirCb (self, abs, cb) { - return function (er, entries) { - if (er) - self._readdirError(abs, er, cb) - else - self._readdirEntries(abs, entries, cb) - } + // TODO: is an absolute `cwd` supposed to be resolved against `root`? + // e.g. { cwd: '/test', root: __dirname } === path.join(__dirname, '/test') + self.cwdAbs = isAbsolute(self.cwd) ? self.cwd : makeAbs(self, self.cwd) + if (process.platform === "win32") + self.cwdAbs = self.cwdAbs.replace(/\\/g, "/") + self.nomount = !!options.nomount + + // disable comments and negation in Minimatch. + // Note that they are not supported in Glob itself anyway. + options.nonegate = true + options.nocomment = true + + self.minimatch = new Minimatch(pattern, options) + self.options = self.minimatch.options } -Glob.prototype._readdirEntries = function (abs, entries, cb) { - if (this.aborted) - return +function finish (self) { + var nou = self.nounique + var all = nou ? [] : Object.create(null) - // if we haven't asked to stat everything, then just - // assume that everything in there exists, so we can avoid - // having to stat it a second time. - if (!this.mark && !this.stat) { - for (var i = 0; i < entries.length; i ++) { - var e = entries[i] - if (abs === '/') - e = abs + e + for (var i = 0, l = self.matches.length; i < l; i ++) { + var matches = self.matches[i] + if (!matches || Object.keys(matches).length === 0) { + if (self.nonull) { + // do like the shell, and spit out the literal glob + var literal = self.minimatch.globSet[i] + if (nou) + all.push(literal) + else + all[literal] = true + } + } else { + // had matches + var m = Object.keys(matches) + if (nou) + all.push.apply(all, m) else - e = abs + '/' + e - this.cache[e] = true + m.forEach(function (m) { + all[m] = true + }) } } - this.cache[abs] = entries - return cb(null, entries) -} - -Glob.prototype._readdirError = function (f, er, cb) { - if (this.aborted) - return - - // handle errors, and cache the information - switch (er.code) { - case 'ENOTSUP': // https://github.com/isaacs/node-glob/issues/205 - case 'ENOTDIR': // totally normal. means it *does* exist. - var abs = this._makeAbs(f) - this.cache[abs] = 'FILE' - if (abs === this.cwdAbs) { - var error = new Error(er.code + ' invalid cwd ' + this.cwd) - error.path = this.cwd - error.code = er.code - this.emit('error', error) - this.abort() - } - break + if (!nou) + all = Object.keys(all) - case 'ENOENT': // not terribly unusual - case 'ELOOP': - case 'ENAMETOOLONG': - case 'UNKNOWN': - this.cache[this._makeAbs(f)] = false - break + if (!self.nosort) + all = all.sort(alphasort) - default: // some unusual error. Treat as failure. - this.cache[this._makeAbs(f)] = false - if (this.strict) { - this.emit('error', er) - // If the error is handled, then we abort - // if not, we threw out of here - this.abort() - } - if (!this.silent) - console.error('glob error', er) - break + // at *some* point we statted all of these + if (self.mark) { + for (var i = 0; i < all.length; i++) { + all[i] = self._mark(all[i]) + } + if (self.nodir) { + all = all.filter(function (e) { + var notDir = !(/\/$/.test(e)) + var c = self.cache[e] || self.cache[makeAbs(self, e)] + if (notDir && c) + notDir = c !== 'DIR' && !Array.isArray(c) + return notDir + }) + } } - return cb() -} + if (self.ignore.length) + all = all.filter(function(m) { + return !isIgnored(self, m) + }) -Glob.prototype._processGlobStar = function (prefix, read, abs, remain, index, inGlobStar, cb) { - var self = this - this._readdir(abs, inGlobStar, function (er, entries) { - self._processGlobStar2(prefix, read, abs, remain, index, inGlobStar, entries, cb) - }) + self.found = all } +function mark (self, p) { + var abs = makeAbs(self, p) + var c = self.cache[abs] + var m = p + if (c) { + var isDir = c === 'DIR' || Array.isArray(c) + var slash = p.slice(-1) === '/' -Glob.prototype._processGlobStar2 = function (prefix, read, abs, remain, index, inGlobStar, entries, cb) { - //console.error('pgs2', prefix, remain[0], entries) + if (isDir && !slash) + m += '/' + else if (!isDir && slash) + m = m.slice(0, -1) - // no entries means not a dir, so it can never have matches - // foo.txt/** doesn't match foo.txt - if (!entries) - return cb() + if (m !== p) { + var mabs = makeAbs(self, m) + self.statCache[mabs] = self.statCache[abs] + self.cache[mabs] = self.cache[abs] + } + } - // test without the globstar, and with every child both below - // and replacing the globstar. - var remainWithoutGlobStar = remain.slice(1) - var gspref = prefix ? [ prefix ] : [] - var noGlobStar = gspref.concat(remainWithoutGlobStar) + return m +} - // the noGlobStar pattern exits the inGlobStar state - this._process(noGlobStar, index, false, cb) - - var isSym = this.symlinks[abs] - var len = entries.length - - // If it's a symlink, and we're in a globstar, then stop - if (isSym && inGlobStar) - return cb() - - for (var i = 0; i < len; i++) { - var e = entries[i] - if (e.charAt(0) === '.' && !this.dot) - continue - - // these two cases enter the inGlobStar state - var instead = gspref.concat(entries[i], remainWithoutGlobStar) - this._process(instead, index, true, cb) - - var below = gspref.concat(entries[i], remain) - this._process(below, index, true, cb) - } - - cb() -} - -Glob.prototype._processSimple = function (prefix, index, cb) { - // XXX review this. Shouldn't it be doing the mounting etc - // before doing stat? kinda weird? - var self = this - this._stat(prefix, function (er, exists) { - self._processSimple2(prefix, index, er, exists, cb) - }) -} -Glob.prototype._processSimple2 = function (prefix, index, er, exists, cb) { - - //console.error('ps2', prefix, exists) - - if (!this.matches[index]) - this.matches[index] = Object.create(null) - - // If it doesn't exist, then just mark the lack of results - if (!exists) - return cb() - - if (prefix && isAbsolute(prefix) && !this.nomount) { - var trail = /[\/\\]$/.test(prefix) - if (prefix.charAt(0) === '/') { - prefix = path.join(this.root, prefix) - } else { - prefix = path.resolve(this.root, prefix) - if (trail) - prefix += '/' - } +// lotta situps... +function makeAbs (self, f) { + var abs = f + if (f.charAt(0) === '/') { + abs = path.join(self.root, f) + } else if (isAbsolute(f) || f === '') { + abs = f + } else if (self.changedCwd) { + abs = path.resolve(self.cwd, f) + } else { + abs = path.resolve(f) } if (process.platform === 'win32') - prefix = prefix.replace(/\\/g, '/') + abs = abs.replace(/\\/g, '/') - // Mark this as a match - this._emitMatch(index, prefix) - cb() + return abs } -// Returns either 'DIR', 'FILE', or false -Glob.prototype._stat = function (f, cb) { - var abs = this._makeAbs(f) - var needDir = f.slice(-1) === '/' - - if (f.length > this.maxLength) - return cb() - - if (!this.stat && ownProp(this.cache, abs)) { - var c = this.cache[abs] - - if (Array.isArray(c)) - c = 'DIR' - - // It exists, but maybe not how we need it - if (!needDir || c === 'DIR') - return cb(null, c) - - if (needDir && c === 'FILE') - return cb() - - // otherwise we have to stat, because maybe c=true - // if we know it exists, but not what it is. - } - - var exists - var stat = this.statCache[abs] - if (stat !== undefined) { - if (stat === false) - return cb(null, stat) - else { - var type = stat.isDirectory() ? 'DIR' : 'FILE' - if (needDir && type === 'FILE') - return cb() - else - return cb(null, type, stat) - } - } - var self = this - var statcb = inflight('stat\0' + abs, lstatcb_) - if (statcb) - self.fs.lstat(abs, statcb) +// Return true, if pattern ends with globstar '**', for the accompanying parent directory. +// Ex:- If node_modules/** is the pattern, add 'node_modules' to ignore list along with it's contents +function isIgnored (self, path) { + if (!self.ignore.length) + return false - function lstatcb_ (er, lstat) { - if (lstat && lstat.isSymbolicLink()) { - // If it's a symlink, then treat it as the target, unless - // the target does not exist, then treat it as a file. - return self.fs.stat(abs, function (er, stat) { - if (er) - self._stat2(f, abs, null, lstat, cb) - else - self._stat2(f, abs, er, stat, cb) - }) - } else { - self._stat2(f, abs, er, lstat, cb) - } - } + return self.ignore.some(function(item) { + return item.matcher.match(path) || !!(item.gmatcher && item.gmatcher.match(path)) + }) } -Glob.prototype._stat2 = function (f, abs, er, stat, cb) { - if (er && (er.code === 'ENOENT' || er.code === 'ENOTDIR')) { - this.statCache[abs] = false - return cb() - } - - var needDir = f.slice(-1) === '/' - this.statCache[abs] = stat - - if (abs.slice(-1) === '/' && stat && !stat.isDirectory()) - return cb(null, false, stat) - - var c = true - if (stat) - c = stat.isDirectory() ? 'DIR' : 'FILE' - this.cache[abs] = this.cache[abs] || c - - if (needDir && c === 'FILE') - return cb() +function childrenIgnored (self, path) { + if (!self.ignore.length) + return false - return cb(null, c, stat) + return self.ignore.some(function(item) { + return !!(item.gmatcher && item.gmatcher.match(path)) + }) } /***/ }), -/***/ "../../node_modules/glob/sync.js": +/***/ "../../node_modules/glob/glob.js": /***/ (function(module, exports, __webpack_require__) { -module.exports = globSync -globSync.GlobSync = GlobSync +// Approach: +// +// 1. Get the minimatch set +// 2. For each pattern in the set, PROCESS(pattern, false) +// 3. Store matches per-set, then uniq them +// +// PROCESS(pattern, inGlobStar) +// Get the first [n] items from pattern that are all strings +// Join these together. This is PREFIX. +// If there is no more remaining, then stat(PREFIX) and +// add to matches if it succeeds. END. +// +// If inGlobStar and PREFIX is symlink and points to dir +// set ENTRIES = [] +// else readdir(PREFIX) as ENTRIES +// If fail, END +// +// with ENTRIES +// If pattern[n] is GLOBSTAR +// // handle the case where the globstar match is empty +// // by pruning it out, and testing the resulting pattern +// PROCESS(pattern[0..n] + pattern[n+1 .. $], false) +// // handle other cases. +// for ENTRY in ENTRIES (not dotfiles) +// // attach globstar + tail onto the entry +// // Mark that this entry is a globstar match +// PROCESS(pattern[0..n] + ENTRY + pattern[n .. $], true) +// +// else // not globstar +// for ENTRY in ENTRIES (not dotfiles, unless pattern[n] is dot) +// Test ENTRY against pattern[n] +// If fails, continue +// If passes, PROCESS(pattern[0..n] + item + pattern[n+1 .. $]) +// +// Caveat: +// Cache all stats and readdirs results to minimize syscall. Since all +// we ever care about is existence and directory-ness, we can just keep +// `true` for files, and [children,...] for directories, or `false` for +// things that don't exist. + +module.exports = glob var rp = __webpack_require__("../../node_modules/fs.realpath/index.js") var minimatch = __webpack_require__("../../node_modules/minimatch/minimatch.js") var Minimatch = minimatch.Minimatch -var Glob = __webpack_require__("../../node_modules/glob/glob.js").Glob -var util = __webpack_require__("util") +var inherits = __webpack_require__("../../node_modules/inherits/inherits.js") +var EE = __webpack_require__("events").EventEmitter var path = __webpack_require__("path") var assert = __webpack_require__("assert") var isAbsolute = __webpack_require__("../../node_modules/path-is-absolute/index.js") +var globSync = __webpack_require__("../../node_modules/glob/sync.js") var common = __webpack_require__("../../node_modules/glob/common.js") var setopts = common.setopts var ownProp = common.ownProp +var inflight = __webpack_require__("../../node_modules/inflight/inflight.js") +var util = __webpack_require__("util") var childrenIgnored = common.childrenIgnored var isIgnored = common.isIgnored -function globSync (pattern, options) { - if (typeof options === 'function' || arguments.length === 3) - throw new TypeError('callback provided to sync glob\n'+ - 'See: https://github.com/isaacs/node-glob/issues/167') - - return new GlobSync(pattern, options).found -} +var once = __webpack_require__("../../node_modules/once/once.js") -function GlobSync (pattern, options) { - if (!pattern) - throw new Error('must provide pattern') +function glob (pattern, options, cb) { + if (typeof options === 'function') cb = options, options = {} + if (!options) options = {} - if (typeof options === 'function' || arguments.length === 3) - throw new TypeError('callback provided to sync glob\n'+ - 'See: https://github.com/isaacs/node-glob/issues/167') + if (options.sync) { + if (cb) + throw new TypeError('callback provided to sync glob') + return globSync(pattern, options) + } - if (!(this instanceof GlobSync)) - return new GlobSync(pattern, options) + return new Glob(pattern, options, cb) +} - setopts(this, pattern, options) +glob.sync = globSync +var GlobSync = glob.GlobSync = globSync.GlobSync - if (this.noprocess) - return this +// old api surface +glob.glob = glob - var n = this.minimatch.set.length - this.matches = new Array(n) - for (var i = 0; i < n; i ++) { - this._process(this.minimatch.set[i], i, false) +function extend (origin, add) { + if (add === null || typeof add !== 'object') { + return origin } - this._finish() -} -GlobSync.prototype._finish = function () { - assert(this instanceof GlobSync) - if (this.realpath) { - var self = this - this.matches.forEach(function (matchset, index) { - var set = self.matches[index] = Object.create(null) - for (var p in matchset) { - try { - p = self._makeAbs(p) - var real = rp.realpathSync(p, self.realpathCache) - set[real] = true - } catch (er) { - if (er.syscall === 'stat') - set[self._makeAbs(p)] = true - else - throw er - } - } + var keys = Object.keys(add) + var i = keys.length + while (i--) { + origin[keys[i]] = add[keys[i]] + } + return origin +} + +glob.hasMagic = function (pattern, options_) { + var options = extend({}, options_) + options.noprocess = true + + var g = new Glob(pattern, options) + var set = g.minimatch.set + + if (!pattern) + return false + + if (set.length > 1) + return true + + for (var j = 0; j < set[0].length; j++) { + if (typeof set[0][j] !== 'string') + return true + } + + return false +} + +glob.Glob = Glob +inherits(Glob, EE) +function Glob (pattern, options, cb) { + if (typeof options === 'function') { + cb = options + options = null + } + + if (options && options.sync) { + if (cb) + throw new TypeError('callback provided to sync glob') + return new GlobSync(pattern, options) + } + + if (!(this instanceof Glob)) + return new Glob(pattern, options, cb) + + setopts(this, pattern, options) + this._didRealPath = false + + // process each pattern in the minimatch set + var n = this.minimatch.set.length + + // The matches are stored as {: true,...} so that + // duplicates are automagically pruned. + // Later, we do an Object.keys() on these. + // Keep them as a list so we can fill in when nonull is set. + this.matches = new Array(n) + + if (typeof cb === 'function') { + cb = once(cb) + this.on('error', cb) + this.on('end', function (matches) { + cb(null, matches) }) } + + var self = this + this._processing = 0 + + this._emitQueue = [] + this._processQueue = [] + this.paused = false + + if (this.noprocess) + return this + + if (n === 0) + return done() + + var sync = true + for (var i = 0; i < n; i ++) { + this._process(this.minimatch.set[i], i, false, done) + } + sync = false + + function done () { + --self._processing + if (self._processing <= 0) { + if (sync) { + process.nextTick(function () { + self._finish() + }) + } else { + self._finish() + } + } + } +} + +Glob.prototype._finish = function () { + assert(this instanceof Glob) + if (this.aborted) + return + + if (this.realpath && !this._didRealpath) + return this._realpath() + common.finish(this) + this.emit('end', this.found) } +Glob.prototype._realpath = function () { + if (this._didRealpath) + return -GlobSync.prototype._process = function (pattern, index, inGlobStar) { - assert(this instanceof GlobSync) + this._didRealpath = true + + var n = this.matches.length + if (n === 0) + return this._finish() + + var self = this + for (var i = 0; i < this.matches.length; i++) + this._realpathSet(i, next) + + function next () { + if (--n === 0) + self._finish() + } +} + +Glob.prototype._realpathSet = function (index, cb) { + var matchset = this.matches[index] + if (!matchset) + return cb() + + var found = Object.keys(matchset) + var self = this + var n = found.length + + if (n === 0) + return cb() + + var set = this.matches[index] = Object.create(null) + found.forEach(function (p, i) { + // If there's a problem with the stat, then it means that + // one or more of the links in the realpath couldn't be + // resolved. just return the abs value in that case. + p = self._makeAbs(p) + rp.realpath(p, self.realpathCache, function (er, real) { + if (!er) + set[real] = true + else if (er.syscall === 'stat') + set[p] = true + else + self.emit('error', er) // srsly wtf right here + + if (--n === 0) { + self.matches[index] = set + cb() + } + }) + }) +} + +Glob.prototype._mark = function (p) { + return common.mark(this, p) +} + +Glob.prototype._makeAbs = function (f) { + return common.makeAbs(this, f) +} + +Glob.prototype.abort = function () { + this.aborted = true + this.emit('abort') +} + +Glob.prototype.pause = function () { + if (!this.paused) { + this.paused = true + this.emit('pause') + } +} + +Glob.prototype.resume = function () { + if (this.paused) { + this.emit('resume') + this.paused = false + if (this._emitQueue.length) { + var eq = this._emitQueue.slice(0) + this._emitQueue.length = 0 + for (var i = 0; i < eq.length; i ++) { + var e = eq[i] + this._emitMatch(e[0], e[1]) + } + } + if (this._processQueue.length) { + var pq = this._processQueue.slice(0) + this._processQueue.length = 0 + for (var i = 0; i < pq.length; i ++) { + var p = pq[i] + this._processing-- + this._process(p[0], p[1], p[2], p[3]) + } + } + } +} + +Glob.prototype._process = function (pattern, index, inGlobStar, cb) { + assert(this instanceof Glob) + assert(typeof cb === 'function') + + if (this.aborted) + return + + this._processing++ + if (this.paused) { + this._processQueue.push([pattern, index, inGlobStar, cb]) + return + } + + //console.error('PROCESS %d', this._processing, pattern) // Get the first [n] parts of pattern that are all strings. var n = 0 @@ -31105,12 +30544,12 @@ GlobSync.prototype._process = function (pattern, index, inGlobStar) { } // now n is the index of the first one that is *not* a string. - // See if there's anything else + // see if there's anything else var prefix switch (n) { // if not, then this is rather simple case pattern.length: - this._processSimple(pattern.join('/'), index) + this._processSimple(pattern.join('/'), index, cb) return case 0: @@ -31142,24 +30581,29 @@ GlobSync.prototype._process = function (pattern, index, inGlobStar) { var abs = this._makeAbs(read) - //if ignored, skip processing + //if ignored, skip _processing if (childrenIgnored(this, read)) - return + return cb() var isGlobStar = remain[0] === minimatch.GLOBSTAR if (isGlobStar) - this._processGlobStar(prefix, read, abs, remain, index, inGlobStar) + this._processGlobStar(prefix, read, abs, remain, index, inGlobStar, cb) else - this._processReaddir(prefix, read, abs, remain, index, inGlobStar) + this._processReaddir(prefix, read, abs, remain, index, inGlobStar, cb) } +Glob.prototype._processReaddir = function (prefix, read, abs, remain, index, inGlobStar, cb) { + var self = this + this._readdir(abs, inGlobStar, function (er, entries) { + return self._processReaddir2(prefix, read, abs, remain, index, inGlobStar, entries, cb) + }) +} -GlobSync.prototype._processReaddir = function (prefix, read, abs, remain, index, inGlobStar) { - var entries = this._readdir(abs, inGlobStar) +Glob.prototype._processReaddir2 = function (prefix, read, abs, remain, index, inGlobStar, entries, cb) { // if the abs isn't a dir, then nothing can match! if (!entries) - return + return cb() // It will only match dot entries if it starts with a dot, or if // dot is set. Stuff like @(.foo|.bar) isn't allowed. @@ -31183,10 +30627,12 @@ GlobSync.prototype._processReaddir = function (prefix, read, abs, remain, index, } } + //console.error('prd2', prefix, entries, remain[0]._glob, matchedEntries) + var len = matchedEntries.length // If there are no matched entries, then nothing matches. if (len === 0) - return + return cb() // if this is the last remaining pattern bit, then no need for // an additional stat *unless* the user has specified mark or @@ -31200,7 +30646,7 @@ GlobSync.prototype._processReaddir = function (prefix, read, abs, remain, index, for (var i = 0; i < len; i ++) { var e = matchedEntries[i] if (prefix) { - if (prefix.slice(-1) !== '/') + if (prefix !== '/') e = prefix + '/' + e else e = prefix + e @@ -31212,7 +30658,7 @@ GlobSync.prototype._processReaddir = function (prefix, read, abs, remain, index, this._emitMatch(index, e) } // This was the last one, and no stats were needed - return + return cb() } // now test all matched entries as stand-ins for that part @@ -31221,27 +30667,36 @@ GlobSync.prototype._processReaddir = function (prefix, read, abs, remain, index, for (var i = 0; i < len; i ++) { var e = matchedEntries[i] var newPattern - if (prefix) - newPattern = [prefix, e] - else - newPattern = [e] - this._process(newPattern.concat(remain), index, inGlobStar) + if (prefix) { + if (prefix !== '/') + e = prefix + '/' + e + else + e = prefix + e + } + this._process([e].concat(remain), index, inGlobStar, cb) } + cb() } +Glob.prototype._emitMatch = function (index, e) { + if (this.aborted) + return -GlobSync.prototype._emitMatch = function (index, e) { if (isIgnored(this, e)) return - var abs = this._makeAbs(e) + if (this.paused) { + this._emitQueue.push([index, e]) + return + } + + var abs = isAbsolute(e) ? e : this._makeAbs(e) if (this.mark) e = this._mark(e) - if (this.absolute) { + if (this.absolute) e = abs - } if (this.matches[index][e]) return @@ -31254,66 +30709,84 @@ GlobSync.prototype._emitMatch = function (index, e) { this.matches[index][e] = true - if (this.stat) - this._stat(e) + var st = this.statCache[abs] + if (st) + this.emit('stat', e, st) + + this.emit('match', e) } +Glob.prototype._readdirInGlobStar = function (abs, cb) { + if (this.aborted) + return -GlobSync.prototype._readdirInGlobStar = function (abs) { // follow all symlinked directories forever // just proceed as if this is a non-globstar situation if (this.follow) - return this._readdir(abs, false) + return this._readdir(abs, false, cb) - var entries - var lstat - var stat - try { - lstat = this.fs.lstatSync(abs) - } catch (er) { - if (er.code === 'ENOENT') { - // lstat failed, doesn't exist - return null - } - } + var lstatkey = 'lstat\0' + abs + var self = this + var lstatcb = inflight(lstatkey, lstatcb_) - var isSym = lstat && lstat.isSymbolicLink() - this.symlinks[abs] = isSym + if (lstatcb) + self.fs.lstat(abs, lstatcb) - // If it's not a symlink or a dir, then it's definitely a regular file. - // don't bother doing a readdir in that case. - if (!isSym && lstat && !lstat.isDirectory()) - this.cache[abs] = 'FILE' - else - entries = this._readdir(abs, false) + function lstatcb_ (er, lstat) { + if (er && er.code === 'ENOENT') + return cb() - return entries + var isSym = lstat && lstat.isSymbolicLink() + self.symlinks[abs] = isSym + + // If it's not a symlink or a dir, then it's definitely a regular file. + // don't bother doing a readdir in that case. + if (!isSym && lstat && !lstat.isDirectory()) { + self.cache[abs] = 'FILE' + cb() + } else + self._readdir(abs, false, cb) + } } -GlobSync.prototype._readdir = function (abs, inGlobStar) { - var entries +Glob.prototype._readdir = function (abs, inGlobStar, cb) { + if (this.aborted) + return + + cb = inflight('readdir\0'+abs+'\0'+inGlobStar, cb) + if (!cb) + return + //console.error('RD %j %j', +inGlobStar, abs) if (inGlobStar && !ownProp(this.symlinks, abs)) - return this._readdirInGlobStar(abs) + return this._readdirInGlobStar(abs, cb) if (ownProp(this.cache, abs)) { var c = this.cache[abs] if (!c || c === 'FILE') - return null + return cb() if (Array.isArray(c)) - return c + return cb(null, c) } - try { - return this._readdirEntries(abs, this.fs.readdirSync(abs)) - } catch (er) { - this._readdirError(abs, er) - return null + var self = this + self.fs.readdir(abs, readdirCb(this, abs, cb)) +} + +function readdirCb (self, abs, cb) { + return function (er, entries) { + if (er) + self._readdirError(abs, er, cb) + else + self._readdirEntries(abs, entries, cb) } } -GlobSync.prototype._readdirEntries = function (abs, entries) { +Glob.prototype._readdirEntries = function (abs, entries, cb) { + if (this.aborted) + return + // if we haven't asked to stat everything, then just // assume that everything in there exists, so we can avoid // having to stat it a second time. @@ -31329,12 +30802,13 @@ GlobSync.prototype._readdirEntries = function (abs, entries) { } this.cache[abs] = entries - - // mark and cache dir-ness - return entries + return cb(null, entries) } -GlobSync.prototype._readdirError = function (f, er) { +Glob.prototype._readdirError = function (f, er, cb) { + if (this.aborted) + return + // handle errors, and cache the information switch (er.code) { case 'ENOTSUP': // https://github.com/isaacs/node-glob/issues/205 @@ -31345,7 +30819,8 @@ GlobSync.prototype._readdirError = function (f, er) { var error = new Error(er.code + ' invalid cwd ' + this.cwd) error.path = this.cwd error.code = er.code - throw error + this.emit('error', error) + this.abort() } break @@ -31358,22 +30833,35 @@ GlobSync.prototype._readdirError = function (f, er) { default: // some unusual error. Treat as failure. this.cache[this._makeAbs(f)] = false - if (this.strict) - throw er + if (this.strict) { + this.emit('error', er) + // If the error is handled, then we abort + // if not, we threw out of here + this.abort() + } if (!this.silent) console.error('glob error', er) break } + + return cb() } -GlobSync.prototype._processGlobStar = function (prefix, read, abs, remain, index, inGlobStar) { +Glob.prototype._processGlobStar = function (prefix, read, abs, remain, index, inGlobStar, cb) { + var self = this + this._readdir(abs, inGlobStar, function (er, entries) { + self._processGlobStar2(prefix, read, abs, remain, index, inGlobStar, entries, cb) + }) +} - var entries = this._readdir(abs, inGlobStar) + +Glob.prototype._processGlobStar2 = function (prefix, read, abs, remain, index, inGlobStar, entries, cb) { + //console.error('pgs2', prefix, remain[0], entries) // no entries means not a dir, so it can never have matches // foo.txt/** doesn't match foo.txt if (!entries) - return + return cb() // test without the globstar, and with every child both below // and replacing the globstar. @@ -31382,14 +30870,14 @@ GlobSync.prototype._processGlobStar = function (prefix, read, abs, remain, index var noGlobStar = gspref.concat(remainWithoutGlobStar) // the noGlobStar pattern exits the inGlobStar state - this._process(noGlobStar, index, false) + this._process(noGlobStar, index, false, cb) - var len = entries.length var isSym = this.symlinks[abs] + var len = entries.length // If it's a symlink, and we're in a globstar, then stop if (isSym && inGlobStar) - return + return cb() for (var i = 0; i < len; i++) { var e = entries[i] @@ -31398,24 +30886,33 @@ GlobSync.prototype._processGlobStar = function (prefix, read, abs, remain, index // these two cases enter the inGlobStar state var instead = gspref.concat(entries[i], remainWithoutGlobStar) - this._process(instead, index, true) + this._process(instead, index, true, cb) var below = gspref.concat(entries[i], remain) - this._process(below, index, true) + this._process(below, index, true, cb) } + + cb() } -GlobSync.prototype._processSimple = function (prefix, index) { +Glob.prototype._processSimple = function (prefix, index, cb) { // XXX review this. Shouldn't it be doing the mounting etc // before doing stat? kinda weird? - var exists = this._stat(prefix) + var self = this + this._stat(prefix, function (er, exists) { + self._processSimple2(prefix, index, er, exists, cb) + }) +} +Glob.prototype._processSimple2 = function (prefix, index, er, exists, cb) { + + //console.error('ps2', prefix, exists) if (!this.matches[index]) this.matches[index] = Object.create(null) // If it doesn't exist, then just mark the lack of results if (!exists) - return + return cb() if (prefix && isAbsolute(prefix) && !this.nomount) { var trail = /[\/\\]$/.test(prefix) @@ -31433,15 +30930,16 @@ GlobSync.prototype._processSimple = function (prefix, index) { // Mark this as a match this._emitMatch(index, prefix) + cb() } // Returns either 'DIR', 'FILE', or false -GlobSync.prototype._stat = function (f) { +Glob.prototype._stat = function (f, cb) { var abs = this._makeAbs(f) var needDir = f.slice(-1) === '/' if (f.length > this.maxLength) - return false + return cb() if (!this.stat && ownProp(this.cache, abs)) { var c = this.cache[abs] @@ -31451,10 +30949,10 @@ GlobSync.prototype._stat = function (f) { // It exists, but maybe not how we need it if (!needDir || c === 'DIR') - return c + return cb(null, c) if (needDir && c === 'FILE') - return false + return cb() // otherwise we have to stat, because maybe c=true // if we know it exists, but not what it is. @@ -31462,2028 +30960,868 @@ GlobSync.prototype._stat = function (f) { var exists var stat = this.statCache[abs] - if (!stat) { - var lstat - try { - lstat = this.fs.lstatSync(abs) - } catch (er) { - if (er && (er.code === 'ENOENT' || er.code === 'ENOTDIR')) { - this.statCache[abs] = false - return false - } + if (stat !== undefined) { + if (stat === false) + return cb(null, stat) + else { + var type = stat.isDirectory() ? 'DIR' : 'FILE' + if (needDir && type === 'FILE') + return cb() + else + return cb(null, type, stat) } + } + + var self = this + var statcb = inflight('stat\0' + abs, lstatcb_) + if (statcb) + self.fs.lstat(abs, statcb) + function lstatcb_ (er, lstat) { if (lstat && lstat.isSymbolicLink()) { - try { - stat = this.fs.statSync(abs) - } catch (er) { - stat = lstat - } + // If it's a symlink, then treat it as the target, unless + // the target does not exist, then treat it as a file. + return self.fs.stat(abs, function (er, stat) { + if (er) + self._stat2(f, abs, null, lstat, cb) + else + self._stat2(f, abs, er, stat, cb) + }) } else { - stat = lstat + self._stat2(f, abs, er, lstat, cb) } } +} + +Glob.prototype._stat2 = function (f, abs, er, stat, cb) { + if (er && (er.code === 'ENOENT' || er.code === 'ENOTDIR')) { + this.statCache[abs] = false + return cb() + } + var needDir = f.slice(-1) === '/' this.statCache[abs] = stat + if (abs.slice(-1) === '/' && stat && !stat.isDirectory()) + return cb(null, false, stat) + var c = true if (stat) c = stat.isDirectory() ? 'DIR' : 'FILE' - this.cache[abs] = this.cache[abs] || c if (needDir && c === 'FILE') - return false + return cb() - return c -} - -GlobSync.prototype._mark = function (p) { - return common.mark(this, p) -} - -GlobSync.prototype._makeAbs = function (f) { - return common.makeAbs(this, f) + return cb(null, c, stat) } /***/ }), -/***/ "../../node_modules/globby/gitignore.js": +/***/ "../../node_modules/glob/sync.js": /***/ (function(module, exports, __webpack_require__) { -"use strict"; +module.exports = globSync +globSync.GlobSync = GlobSync -const {promisify} = __webpack_require__("util"); -const fs = __webpack_require__("fs"); -const path = __webpack_require__("path"); -const fastGlob = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/index.js"); -const gitIgnore = __webpack_require__("../../node_modules/ignore/index.js"); -const slash = __webpack_require__("../../node_modules/slash/index.js"); +var rp = __webpack_require__("../../node_modules/fs.realpath/index.js") +var minimatch = __webpack_require__("../../node_modules/minimatch/minimatch.js") +var Minimatch = minimatch.Minimatch +var Glob = __webpack_require__("../../node_modules/glob/glob.js").Glob +var util = __webpack_require__("util") +var path = __webpack_require__("path") +var assert = __webpack_require__("assert") +var isAbsolute = __webpack_require__("../../node_modules/path-is-absolute/index.js") +var common = __webpack_require__("../../node_modules/glob/common.js") +var setopts = common.setopts +var ownProp = common.ownProp +var childrenIgnored = common.childrenIgnored +var isIgnored = common.isIgnored -const DEFAULT_IGNORE = [ - '**/node_modules/**', - '**/flow-typed/**', - '**/coverage/**', - '**/.git' -]; +function globSync (pattern, options) { + if (typeof options === 'function' || arguments.length === 3) + throw new TypeError('callback provided to sync glob\n'+ + 'See: https://github.com/isaacs/node-glob/issues/167') -const readFileP = promisify(fs.readFile); + return new GlobSync(pattern, options).found +} -const mapGitIgnorePatternTo = base => ignore => { - if (ignore.startsWith('!')) { - return '!' + path.posix.join(base, ignore.slice(1)); - } +function GlobSync (pattern, options) { + if (!pattern) + throw new Error('must provide pattern') - return path.posix.join(base, ignore); -}; + if (typeof options === 'function' || arguments.length === 3) + throw new TypeError('callback provided to sync glob\n'+ + 'See: https://github.com/isaacs/node-glob/issues/167') -const parseGitIgnore = (content, options) => { - const base = slash(path.relative(options.cwd, path.dirname(options.fileName))); + if (!(this instanceof GlobSync)) + return new GlobSync(pattern, options) - return content - .split(/\r?\n/) - .filter(Boolean) - .filter(line => !line.startsWith('#')) - .map(mapGitIgnorePatternTo(base)); -}; + setopts(this, pattern, options) -const reduceIgnore = files => { - const ignores = gitIgnore(); - for (const file of files) { - ignores.add(parseGitIgnore(file.content, { - cwd: file.cwd, - fileName: file.filePath - })); - } + if (this.noprocess) + return this - return ignores; -}; + var n = this.minimatch.set.length + this.matches = new Array(n) + for (var i = 0; i < n; i ++) { + this._process(this.minimatch.set[i], i, false) + } + this._finish() +} -const ensureAbsolutePathForCwd = (cwd, p) => { - cwd = slash(cwd); - if (path.isAbsolute(p)) { - if (slash(p).startsWith(cwd)) { - return p; - } +GlobSync.prototype._finish = function () { + assert(this instanceof GlobSync) + if (this.realpath) { + var self = this + this.matches.forEach(function (matchset, index) { + var set = self.matches[index] = Object.create(null) + for (var p in matchset) { + try { + p = self._makeAbs(p) + var real = rp.realpathSync(p, self.realpathCache) + set[real] = true + } catch (er) { + if (er.syscall === 'stat') + set[self._makeAbs(p)] = true + else + throw er + } + } + }) + } + common.finish(this) +} - throw new Error(`Path ${p} is not in cwd ${cwd}`); - } - return path.join(cwd, p); -}; +GlobSync.prototype._process = function (pattern, index, inGlobStar) { + assert(this instanceof GlobSync) -const getIsIgnoredPredecate = (ignores, cwd) => { - return p => ignores.ignores(slash(path.relative(cwd, ensureAbsolutePathForCwd(cwd, p.path || p)))); -}; + // Get the first [n] parts of pattern that are all strings. + var n = 0 + while (typeof pattern[n] === 'string') { + n ++ + } + // now n is the index of the first one that is *not* a string. -const getFile = async (file, cwd) => { - const filePath = path.join(cwd, file); - const content = await readFileP(filePath, 'utf8'); + // See if there's anything else + var prefix + switch (n) { + // if not, then this is rather simple + case pattern.length: + this._processSimple(pattern.join('/'), index) + return - return { - cwd, - filePath, - content - }; -}; + case 0: + // pattern *starts* with some non-trivial item. + // going to readdir(cwd), but not include the prefix in matches. + prefix = null + break -const getFileSync = (file, cwd) => { - const filePath = path.join(cwd, file); - const content = fs.readFileSync(filePath, 'utf8'); + default: + // pattern has some string bits in the front. + // whatever it starts with, whether that's 'absolute' like /foo/bar, + // or 'relative' like '../baz' + prefix = pattern.slice(0, n).join('/') + break + } - return { - cwd, - filePath, - content - }; -}; + var remain = pattern.slice(n) -const normalizeOptions = ({ - ignore = [], - cwd = slash(process.cwd()) -} = {}) => { - return {ignore, cwd}; -}; + // get the list of entries. + var read + if (prefix === null) + read = '.' + else if (isAbsolute(prefix) || isAbsolute(pattern.join('/'))) { + if (!prefix || !isAbsolute(prefix)) + prefix = '/' + prefix + read = prefix + } else + read = prefix -module.exports = async options => { - options = normalizeOptions(options); + var abs = this._makeAbs(read) - const paths = await fastGlob('**/.gitignore', { - ignore: DEFAULT_IGNORE.concat(options.ignore), - cwd: options.cwd - }); + //if ignored, skip processing + if (childrenIgnored(this, read)) + return - const files = await Promise.all(paths.map(file => getFile(file, options.cwd))); - const ignores = reduceIgnore(files); + var isGlobStar = remain[0] === minimatch.GLOBSTAR + if (isGlobStar) + this._processGlobStar(prefix, read, abs, remain, index, inGlobStar) + else + this._processReaddir(prefix, read, abs, remain, index, inGlobStar) +} - return getIsIgnoredPredecate(ignores, options.cwd); -}; -module.exports.sync = options => { - options = normalizeOptions(options); +GlobSync.prototype._processReaddir = function (prefix, read, abs, remain, index, inGlobStar) { + var entries = this._readdir(abs, inGlobStar) - const paths = fastGlob.sync('**/.gitignore', { - ignore: DEFAULT_IGNORE.concat(options.ignore), - cwd: options.cwd - }); + // if the abs isn't a dir, then nothing can match! + if (!entries) + return - const files = paths.map(file => getFileSync(file, options.cwd)); - const ignores = reduceIgnore(files); + // It will only match dot entries if it starts with a dot, or if + // dot is set. Stuff like @(.foo|.bar) isn't allowed. + var pn = remain[0] + var negate = !!this.minimatch.negate + var rawGlob = pn._glob + var dotOk = this.dot || rawGlob.charAt(0) === '.' - return getIsIgnoredPredecate(ignores, options.cwd); -}; + var matchedEntries = [] + for (var i = 0; i < entries.length; i++) { + var e = entries[i] + if (e.charAt(0) !== '.' || dotOk) { + var m + if (negate && !prefix) { + m = !e.match(pn) + } else { + m = e.match(pn) + } + if (m) + matchedEntries.push(e) + } + } + var len = matchedEntries.length + // If there are no matched entries, then nothing matches. + if (len === 0) + return -/***/ }), + // if this is the last remaining pattern bit, then no need for + // an additional stat *unless* the user has specified mark or + // stat explicitly. We know they exist, since readdir returned + // them. -/***/ "../../node_modules/globby/index.js": -/***/ (function(module, exports, __webpack_require__) { + if (remain.length === 1 && !this.mark && !this.stat) { + if (!this.matches[index]) + this.matches[index] = Object.create(null) -"use strict"; + for (var i = 0; i < len; i ++) { + var e = matchedEntries[i] + if (prefix) { + if (prefix.slice(-1) !== '/') + e = prefix + '/' + e + else + e = prefix + e + } -const fs = __webpack_require__("fs"); -const arrayUnion = __webpack_require__("../../node_modules/array-union/index.js"); -const merge2 = __webpack_require__("../../node_modules/merge2/index.js"); -const fastGlob = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/index.js"); -const dirGlob = __webpack_require__("../../node_modules/dir-glob/index.js"); -const gitignore = __webpack_require__("../../node_modules/globby/gitignore.js"); -const {FilterStream, UniqueStream} = __webpack_require__("../../node_modules/globby/stream-utils.js"); + if (e.charAt(0) === '/' && !this.nomount) { + e = path.join(this.root, e) + } + this._emitMatch(index, e) + } + // This was the last one, and no stats were needed + return + } -const DEFAULT_FILTER = () => false; + // now test all matched entries as stand-ins for that part + // of the pattern. + remain.shift() + for (var i = 0; i < len; i ++) { + var e = matchedEntries[i] + var newPattern + if (prefix) + newPattern = [prefix, e] + else + newPattern = [e] + this._process(newPattern.concat(remain), index, inGlobStar) + } +} -const isNegative = pattern => pattern[0] === '!'; -const assertPatternsInput = patterns => { - if (!patterns.every(pattern => typeof pattern === 'string')) { - throw new TypeError('Patterns must be a string or an array of strings'); - } -}; +GlobSync.prototype._emitMatch = function (index, e) { + if (isIgnored(this, e)) + return -const checkCwdOption = (options = {}) => { - if (!options.cwd) { - return; - } + var abs = this._makeAbs(e) - let stat; - try { - stat = fs.statSync(options.cwd); - } catch { - return; - } + if (this.mark) + e = this._mark(e) - if (!stat.isDirectory()) { - throw new Error('The `cwd` option must be a path to a directory'); - } -}; + if (this.absolute) { + e = abs + } -const getPathString = p => p.stats instanceof fs.Stats ? p.path : p; + if (this.matches[index][e]) + return -const generateGlobTasks = (patterns, taskOptions) => { - patterns = arrayUnion([].concat(patterns)); - assertPatternsInput(patterns); - checkCwdOption(taskOptions); + if (this.nodir) { + var c = this.cache[abs] + if (c === 'DIR' || Array.isArray(c)) + return + } - const globTasks = []; + this.matches[index][e] = true - taskOptions = { - ignore: [], - expandDirectories: true, - ...taskOptions - }; + if (this.stat) + this._stat(e) +} - for (const [index, pattern] of patterns.entries()) { - if (isNegative(pattern)) { - continue; - } - const ignore = patterns - .slice(index) - .filter(pattern => isNegative(pattern)) - .map(pattern => pattern.slice(1)); +GlobSync.prototype._readdirInGlobStar = function (abs) { + // follow all symlinked directories forever + // just proceed as if this is a non-globstar situation + if (this.follow) + return this._readdir(abs, false) - const options = { - ...taskOptions, - ignore: taskOptions.ignore.concat(ignore) - }; + var entries + var lstat + var stat + try { + lstat = this.fs.lstatSync(abs) + } catch (er) { + if (er.code === 'ENOENT') { + // lstat failed, doesn't exist + return null + } + } - globTasks.push({pattern, options}); - } + var isSym = lstat && lstat.isSymbolicLink() + this.symlinks[abs] = isSym - return globTasks; -}; + // If it's not a symlink or a dir, then it's definitely a regular file. + // don't bother doing a readdir in that case. + if (!isSym && lstat && !lstat.isDirectory()) + this.cache[abs] = 'FILE' + else + entries = this._readdir(abs, false) -const globDirs = (task, fn) => { - let options = {}; - if (task.options.cwd) { - options.cwd = task.options.cwd; - } + return entries +} - if (Array.isArray(task.options.expandDirectories)) { - options = { - ...options, - files: task.options.expandDirectories - }; - } else if (typeof task.options.expandDirectories === 'object') { - options = { - ...options, - ...task.options.expandDirectories - }; - } +GlobSync.prototype._readdir = function (abs, inGlobStar) { + var entries - return fn(task.pattern, options); -}; + if (inGlobStar && !ownProp(this.symlinks, abs)) + return this._readdirInGlobStar(abs) -const getPattern = (task, fn) => task.options.expandDirectories ? globDirs(task, fn) : [task.pattern]; + if (ownProp(this.cache, abs)) { + var c = this.cache[abs] + if (!c || c === 'FILE') + return null -const getFilterSync = options => { - return options && options.gitignore ? - gitignore.sync({cwd: options.cwd, ignore: options.ignore}) : - DEFAULT_FILTER; -}; + if (Array.isArray(c)) + return c + } -const globToTask = task => glob => { - const {options} = task; - if (options.ignore && Array.isArray(options.ignore) && options.expandDirectories) { - options.ignore = dirGlob.sync(options.ignore); - } + try { + return this._readdirEntries(abs, this.fs.readdirSync(abs)) + } catch (er) { + this._readdirError(abs, er) + return null + } +} - return { - pattern: glob, - options - }; -}; +GlobSync.prototype._readdirEntries = function (abs, entries) { + // if we haven't asked to stat everything, then just + // assume that everything in there exists, so we can avoid + // having to stat it a second time. + if (!this.mark && !this.stat) { + for (var i = 0; i < entries.length; i ++) { + var e = entries[i] + if (abs === '/') + e = abs + e + else + e = abs + '/' + e + this.cache[e] = true + } + } -module.exports = async (patterns, options) => { - const globTasks = generateGlobTasks(patterns, options); + this.cache[abs] = entries - const getFilter = async () => { - return options && options.gitignore ? - gitignore({cwd: options.cwd, ignore: options.ignore}) : - DEFAULT_FILTER; - }; + // mark and cache dir-ness + return entries +} - const getTasks = async () => { - const tasks = await Promise.all(globTasks.map(async task => { - const globs = await getPattern(task, dirGlob); - return Promise.all(globs.map(globToTask(task))); - })); +GlobSync.prototype._readdirError = function (f, er) { + // handle errors, and cache the information + switch (er.code) { + case 'ENOTSUP': // https://github.com/isaacs/node-glob/issues/205 + case 'ENOTDIR': // totally normal. means it *does* exist. + var abs = this._makeAbs(f) + this.cache[abs] = 'FILE' + if (abs === this.cwdAbs) { + var error = new Error(er.code + ' invalid cwd ' + this.cwd) + error.path = this.cwd + error.code = er.code + throw error + } + break - return arrayUnion(...tasks); - }; + case 'ENOENT': // not terribly unusual + case 'ELOOP': + case 'ENAMETOOLONG': + case 'UNKNOWN': + this.cache[this._makeAbs(f)] = false + break - const [filter, tasks] = await Promise.all([getFilter(), getTasks()]); - const paths = await Promise.all(tasks.map(task => fastGlob(task.pattern, task.options))); + default: // some unusual error. Treat as failure. + this.cache[this._makeAbs(f)] = false + if (this.strict) + throw er + if (!this.silent) + console.error('glob error', er) + break + } +} - return arrayUnion(...paths).filter(path_ => !filter(getPathString(path_))); -}; +GlobSync.prototype._processGlobStar = function (prefix, read, abs, remain, index, inGlobStar) { -module.exports.sync = (patterns, options) => { - const globTasks = generateGlobTasks(patterns, options); + var entries = this._readdir(abs, inGlobStar) - const tasks = []; - for (const task of globTasks) { - const newTask = getPattern(task, dirGlob.sync).map(globToTask(task)); - tasks.push(...newTask); - } + // no entries means not a dir, so it can never have matches + // foo.txt/** doesn't match foo.txt + if (!entries) + return - const filter = getFilterSync(options); + // test without the globstar, and with every child both below + // and replacing the globstar. + var remainWithoutGlobStar = remain.slice(1) + var gspref = prefix ? [ prefix ] : [] + var noGlobStar = gspref.concat(remainWithoutGlobStar) - let matches = []; - for (const task of tasks) { - matches = arrayUnion(matches, fastGlob.sync(task.pattern, task.options)); - } - - return matches.filter(path_ => !filter(path_)); -}; - -module.exports.stream = (patterns, options) => { - const globTasks = generateGlobTasks(patterns, options); - - const tasks = []; - for (const task of globTasks) { - const newTask = getPattern(task, dirGlob.sync).map(globToTask(task)); - tasks.push(...newTask); - } - - const filter = getFilterSync(options); - const filterStream = new FilterStream(p => !filter(p)); - const uniqueStream = new UniqueStream(); - - return merge2(tasks.map(task => fastGlob.stream(task.pattern, task.options))) - .pipe(filterStream) - .pipe(uniqueStream); -}; - -module.exports.generateGlobTasks = generateGlobTasks; - -module.exports.hasMagic = (patterns, options) => [] - .concat(patterns) - .some(pattern => fastGlob.isDynamicPattern(pattern, options)); - -module.exports.gitignore = gitignore; - - -/***/ }), - -/***/ "../../node_modules/globby/node_modules/fast-glob/out/index.js": -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - -const taskManager = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/managers/tasks.js"); -const async_1 = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/providers/async.js"); -const stream_1 = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/providers/stream.js"); -const sync_1 = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/providers/sync.js"); -const settings_1 = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/settings.js"); -const utils = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/utils/index.js"); -async function FastGlob(source, options) { - assertPatternsInput(source); - const works = getWorks(source, async_1.default, options); - const result = await Promise.all(works); - return utils.array.flatten(result); -} -// https://github.com/typescript-eslint/typescript-eslint/issues/60 -// eslint-disable-next-line no-redeclare -(function (FastGlob) { - function sync(source, options) { - assertPatternsInput(source); - const works = getWorks(source, sync_1.default, options); - return utils.array.flatten(works); - } - FastGlob.sync = sync; - function stream(source, options) { - assertPatternsInput(source); - const works = getWorks(source, stream_1.default, options); - /** - * The stream returned by the provider cannot work with an asynchronous iterator. - * To support asynchronous iterators, regardless of the number of tasks, we always multiplex streams. - * This affects performance (+25%). I don't see best solution right now. - */ - return utils.stream.merge(works); - } - FastGlob.stream = stream; - function generateTasks(source, options) { - assertPatternsInput(source); - const patterns = [].concat(source); - const settings = new settings_1.default(options); - return taskManager.generate(patterns, settings); - } - FastGlob.generateTasks = generateTasks; - function isDynamicPattern(source, options) { - assertPatternsInput(source); - const settings = new settings_1.default(options); - return utils.pattern.isDynamicPattern(source, settings); - } - FastGlob.isDynamicPattern = isDynamicPattern; - function escapePath(source) { - assertPatternsInput(source); - return utils.path.escape(source); - } - FastGlob.escapePath = escapePath; -})(FastGlob || (FastGlob = {})); -function getWorks(source, _Provider, options) { - const patterns = [].concat(source); - const settings = new settings_1.default(options); - const tasks = taskManager.generate(patterns, settings); - const provider = new _Provider(settings); - return tasks.map(provider.read, provider); -} -function assertPatternsInput(input) { - const source = [].concat(input); - const isValidSource = source.every((item) => utils.string.isString(item) && !utils.string.isEmpty(item)); - if (!isValidSource) { - throw new TypeError('Patterns must be a string (non empty) or an array of strings'); - } -} -module.exports = FastGlob; - - -/***/ }), - -/***/ "../../node_modules/globby/node_modules/fast-glob/out/managers/tasks.js": -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - -Object.defineProperty(exports, "__esModule", { value: true }); -exports.convertPatternGroupToTask = exports.convertPatternGroupsToTasks = exports.groupPatternsByBaseDirectory = exports.getNegativePatternsAsPositive = exports.getPositivePatterns = exports.convertPatternsToTasks = exports.generate = void 0; -const utils = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/utils/index.js"); -function generate(patterns, settings) { - const positivePatterns = getPositivePatterns(patterns); - const negativePatterns = getNegativePatternsAsPositive(patterns, settings.ignore); - const staticPatterns = positivePatterns.filter((pattern) => utils.pattern.isStaticPattern(pattern, settings)); - const dynamicPatterns = positivePatterns.filter((pattern) => utils.pattern.isDynamicPattern(pattern, settings)); - const staticTasks = convertPatternsToTasks(staticPatterns, negativePatterns, /* dynamic */ false); - const dynamicTasks = convertPatternsToTasks(dynamicPatterns, negativePatterns, /* dynamic */ true); - return staticTasks.concat(dynamicTasks); -} -exports.generate = generate; -/** - * Returns tasks grouped by basic pattern directories. - * - * Patterns that can be found inside (`./`) and outside (`../`) the current directory are handled separately. - * This is necessary because directory traversal starts at the base directory and goes deeper. - */ -function convertPatternsToTasks(positive, negative, dynamic) { - const tasks = []; - const patternsOutsideCurrentDirectory = utils.pattern.getPatternsOutsideCurrentDirectory(positive); - const patternsInsideCurrentDirectory = utils.pattern.getPatternsInsideCurrentDirectory(positive); - const outsideCurrentDirectoryGroup = groupPatternsByBaseDirectory(patternsOutsideCurrentDirectory); - const insideCurrentDirectoryGroup = groupPatternsByBaseDirectory(patternsInsideCurrentDirectory); - tasks.push(...convertPatternGroupsToTasks(outsideCurrentDirectoryGroup, negative, dynamic)); - /* - * For the sake of reducing future accesses to the file system, we merge all tasks within the current directory - * into a global task, if at least one pattern refers to the root (`.`). In this case, the global task covers the rest. - */ - if ('.' in insideCurrentDirectoryGroup) { - tasks.push(convertPatternGroupToTask('.', patternsInsideCurrentDirectory, negative, dynamic)); - } - else { - tasks.push(...convertPatternGroupsToTasks(insideCurrentDirectoryGroup, negative, dynamic)); - } - return tasks; -} -exports.convertPatternsToTasks = convertPatternsToTasks; -function getPositivePatterns(patterns) { - return utils.pattern.getPositivePatterns(patterns); -} -exports.getPositivePatterns = getPositivePatterns; -function getNegativePatternsAsPositive(patterns, ignore) { - const negative = utils.pattern.getNegativePatterns(patterns).concat(ignore); - const positive = negative.map(utils.pattern.convertToPositivePattern); - return positive; -} -exports.getNegativePatternsAsPositive = getNegativePatternsAsPositive; -function groupPatternsByBaseDirectory(patterns) { - const group = {}; - return patterns.reduce((collection, pattern) => { - const base = utils.pattern.getBaseDirectory(pattern); - if (base in collection) { - collection[base].push(pattern); - } - else { - collection[base] = [pattern]; - } - return collection; - }, group); -} -exports.groupPatternsByBaseDirectory = groupPatternsByBaseDirectory; -function convertPatternGroupsToTasks(positive, negative, dynamic) { - return Object.keys(positive).map((base) => { - return convertPatternGroupToTask(base, positive[base], negative, dynamic); - }); -} -exports.convertPatternGroupsToTasks = convertPatternGroupsToTasks; -function convertPatternGroupToTask(base, positive, negative, dynamic) { - return { - dynamic, - positive, - negative, - base, - patterns: [].concat(positive, negative.map(utils.pattern.convertToNegativePattern)) - }; -} -exports.convertPatternGroupToTask = convertPatternGroupToTask; - - -/***/ }), - -/***/ "../../node_modules/globby/node_modules/fast-glob/out/providers/async.js": -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - -Object.defineProperty(exports, "__esModule", { value: true }); -const stream_1 = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/readers/stream.js"); -const provider_1 = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/providers/provider.js"); -class ProviderAsync extends provider_1.default { - constructor() { - super(...arguments); - this._reader = new stream_1.default(this._settings); - } - read(task) { - const root = this._getRootDirectory(task); - const options = this._getReaderOptions(task); - const entries = []; - return new Promise((resolve, reject) => { - const stream = this.api(root, task, options); - stream.once('error', reject); - stream.on('data', (entry) => entries.push(options.transform(entry))); - stream.once('end', () => resolve(entries)); - }); - } - api(root, task, options) { - if (task.dynamic) { - return this._reader.dynamic(root, options); - } - return this._reader.static(task.patterns, options); - } -} -exports.default = ProviderAsync; - - -/***/ }), - -/***/ "../../node_modules/globby/node_modules/fast-glob/out/providers/filters/deep.js": -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - -Object.defineProperty(exports, "__esModule", { value: true }); -const utils = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/utils/index.js"); -const partial_1 = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/providers/matchers/partial.js"); -class DeepFilter { - constructor(_settings, _micromatchOptions) { - this._settings = _settings; - this._micromatchOptions = _micromatchOptions; - } - getFilter(basePath, positive, negative) { - const matcher = this._getMatcher(positive); - const negativeRe = this._getNegativePatternsRe(negative); - return (entry) => this._filter(basePath, entry, matcher, negativeRe); - } - _getMatcher(patterns) { - return new partial_1.default(patterns, this._settings, this._micromatchOptions); - } - _getNegativePatternsRe(patterns) { - const affectDepthOfReadingPatterns = patterns.filter(utils.pattern.isAffectDepthOfReadingPattern); - return utils.pattern.convertPatternsToRe(affectDepthOfReadingPatterns, this._micromatchOptions); - } - _filter(basePath, entry, matcher, negativeRe) { - if (this._isSkippedByDeep(basePath, entry.path)) { - return false; - } - if (this._isSkippedSymbolicLink(entry)) { - return false; - } - const filepath = utils.path.removeLeadingDotSegment(entry.path); - if (this._isSkippedByPositivePatterns(filepath, matcher)) { - return false; - } - return this._isSkippedByNegativePatterns(filepath, negativeRe); - } - _isSkippedByDeep(basePath, entryPath) { - /** - * Avoid unnecessary depth calculations when it doesn't matter. - */ - if (this._settings.deep === Infinity) { - return false; - } - return this._getEntryLevel(basePath, entryPath) >= this._settings.deep; - } - _getEntryLevel(basePath, entryPath) { - const entryPathDepth = entryPath.split('/').length; - if (basePath === '') { - return entryPathDepth; - } - const basePathDepth = basePath.split('/').length; - return entryPathDepth - basePathDepth; - } - _isSkippedSymbolicLink(entry) { - return !this._settings.followSymbolicLinks && entry.dirent.isSymbolicLink(); - } - _isSkippedByPositivePatterns(entryPath, matcher) { - return !this._settings.baseNameMatch && !matcher.match(entryPath); - } - _isSkippedByNegativePatterns(entryPath, patternsRe) { - return !utils.pattern.matchAny(entryPath, patternsRe); - } -} -exports.default = DeepFilter; - - -/***/ }), - -/***/ "../../node_modules/globby/node_modules/fast-glob/out/providers/filters/entry.js": -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - -Object.defineProperty(exports, "__esModule", { value: true }); -const utils = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/utils/index.js"); -class EntryFilter { - constructor(_settings, _micromatchOptions) { - this._settings = _settings; - this._micromatchOptions = _micromatchOptions; - this.index = new Map(); - } - getFilter(positive, negative) { - const positiveRe = utils.pattern.convertPatternsToRe(positive, this._micromatchOptions); - const negativeRe = utils.pattern.convertPatternsToRe(negative, this._micromatchOptions); - return (entry) => this._filter(entry, positiveRe, negativeRe); - } - _filter(entry, positiveRe, negativeRe) { - if (this._settings.unique && this._isDuplicateEntry(entry)) { - return false; - } - if (this._onlyFileFilter(entry) || this._onlyDirectoryFilter(entry)) { - return false; - } - if (this._isSkippedByAbsoluteNegativePatterns(entry.path, negativeRe)) { - return false; - } - const filepath = this._settings.baseNameMatch ? entry.name : entry.path; - const isMatched = this._isMatchToPatterns(filepath, positiveRe) && !this._isMatchToPatterns(entry.path, negativeRe); - if (this._settings.unique && isMatched) { - this._createIndexRecord(entry); - } - return isMatched; - } - _isDuplicateEntry(entry) { - return this.index.has(entry.path); - } - _createIndexRecord(entry) { - this.index.set(entry.path, undefined); - } - _onlyFileFilter(entry) { - return this._settings.onlyFiles && !entry.dirent.isFile(); - } - _onlyDirectoryFilter(entry) { - return this._settings.onlyDirectories && !entry.dirent.isDirectory(); - } - _isSkippedByAbsoluteNegativePatterns(entryPath, patternsRe) { - if (!this._settings.absolute) { - return false; - } - const fullpath = utils.path.makeAbsolute(this._settings.cwd, entryPath); - return utils.pattern.matchAny(fullpath, patternsRe); - } - _isMatchToPatterns(entryPath, patternsRe) { - const filepath = utils.path.removeLeadingDotSegment(entryPath); - return utils.pattern.matchAny(filepath, patternsRe); - } -} -exports.default = EntryFilter; - - -/***/ }), - -/***/ "../../node_modules/globby/node_modules/fast-glob/out/providers/filters/error.js": -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - -Object.defineProperty(exports, "__esModule", { value: true }); -const utils = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/utils/index.js"); -class ErrorFilter { - constructor(_settings) { - this._settings = _settings; - } - getFilter() { - return (error) => this._isNonFatalError(error); - } - _isNonFatalError(error) { - return utils.errno.isEnoentCodeError(error) || this._settings.suppressErrors; - } -} -exports.default = ErrorFilter; - - -/***/ }), - -/***/ "../../node_modules/globby/node_modules/fast-glob/out/providers/matchers/matcher.js": -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - -Object.defineProperty(exports, "__esModule", { value: true }); -const utils = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/utils/index.js"); -class Matcher { - constructor(_patterns, _settings, _micromatchOptions) { - this._patterns = _patterns; - this._settings = _settings; - this._micromatchOptions = _micromatchOptions; - this._storage = []; - this._fillStorage(); - } - _fillStorage() { - /** - * The original pattern may include `{,*,**,a/*}`, which will lead to problems with matching (unresolved level). - * So, before expand patterns with brace expansion into separated patterns. - */ - const patterns = utils.pattern.expandPatternsWithBraceExpansion(this._patterns); - for (const pattern of patterns) { - const segments = this._getPatternSegments(pattern); - const sections = this._splitSegmentsIntoSections(segments); - this._storage.push({ - complete: sections.length <= 1, - pattern, - segments, - sections - }); - } - } - _getPatternSegments(pattern) { - const parts = utils.pattern.getPatternParts(pattern, this._micromatchOptions); - return parts.map((part) => { - const dynamic = utils.pattern.isDynamicPattern(part, this._settings); - if (!dynamic) { - return { - dynamic: false, - pattern: part - }; - } - return { - dynamic: true, - pattern: part, - patternRe: utils.pattern.makeRe(part, this._micromatchOptions) - }; - }); - } - _splitSegmentsIntoSections(segments) { - return utils.array.splitWhen(segments, (segment) => segment.dynamic && utils.pattern.hasGlobStar(segment.pattern)); - } -} -exports.default = Matcher; - - -/***/ }), - -/***/ "../../node_modules/globby/node_modules/fast-glob/out/providers/matchers/partial.js": -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - -Object.defineProperty(exports, "__esModule", { value: true }); -const matcher_1 = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/providers/matchers/matcher.js"); -class PartialMatcher extends matcher_1.default { - match(filepath) { - const parts = filepath.split('/'); - const levels = parts.length; - const patterns = this._storage.filter((info) => !info.complete || info.segments.length > levels); - for (const pattern of patterns) { - const section = pattern.sections[0]; - /** - * In this case, the pattern has a globstar and we must read all directories unconditionally, - * but only if the level has reached the end of the first group. - * - * fixtures/{a,b}/** - * ^ true/false ^ always true - */ - if (!pattern.complete && levels > section.length) { - return true; - } - const match = parts.every((part, index) => { - const segment = pattern.segments[index]; - if (segment.dynamic && segment.patternRe.test(part)) { - return true; - } - if (!segment.dynamic && segment.pattern === part) { - return true; - } - return false; - }); - if (match) { - return true; - } - } - return false; - } -} -exports.default = PartialMatcher; - - -/***/ }), - -/***/ "../../node_modules/globby/node_modules/fast-glob/out/providers/provider.js": -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - -Object.defineProperty(exports, "__esModule", { value: true }); -const path = __webpack_require__("path"); -const deep_1 = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/providers/filters/deep.js"); -const entry_1 = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/providers/filters/entry.js"); -const error_1 = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/providers/filters/error.js"); -const entry_2 = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/providers/transformers/entry.js"); -class Provider { - constructor(_settings) { - this._settings = _settings; - this.errorFilter = new error_1.default(this._settings); - this.entryFilter = new entry_1.default(this._settings, this._getMicromatchOptions()); - this.deepFilter = new deep_1.default(this._settings, this._getMicromatchOptions()); - this.entryTransformer = new entry_2.default(this._settings); - } - _getRootDirectory(task) { - return path.resolve(this._settings.cwd, task.base); - } - _getReaderOptions(task) { - const basePath = task.base === '.' ? '' : task.base; - return { - basePath, - pathSegmentSeparator: '/', - concurrency: this._settings.concurrency, - deepFilter: this.deepFilter.getFilter(basePath, task.positive, task.negative), - entryFilter: this.entryFilter.getFilter(task.positive, task.negative), - errorFilter: this.errorFilter.getFilter(), - followSymbolicLinks: this._settings.followSymbolicLinks, - fs: this._settings.fs, - stats: this._settings.stats, - throwErrorOnBrokenSymbolicLink: this._settings.throwErrorOnBrokenSymbolicLink, - transform: this.entryTransformer.getTransformer() - }; - } - _getMicromatchOptions() { - return { - dot: this._settings.dot, - matchBase: this._settings.baseNameMatch, - nobrace: !this._settings.braceExpansion, - nocase: !this._settings.caseSensitiveMatch, - noext: !this._settings.extglob, - noglobstar: !this._settings.globstar, - posix: true, - strictSlashes: false - }; - } -} -exports.default = Provider; - - -/***/ }), - -/***/ "../../node_modules/globby/node_modules/fast-glob/out/providers/stream.js": -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - -Object.defineProperty(exports, "__esModule", { value: true }); -const stream_1 = __webpack_require__("stream"); -const stream_2 = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/readers/stream.js"); -const provider_1 = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/providers/provider.js"); -class ProviderStream extends provider_1.default { - constructor() { - super(...arguments); - this._reader = new stream_2.default(this._settings); - } - read(task) { - const root = this._getRootDirectory(task); - const options = this._getReaderOptions(task); - const source = this.api(root, task, options); - const destination = new stream_1.Readable({ objectMode: true, read: () => { } }); - source - .once('error', (error) => destination.emit('error', error)) - .on('data', (entry) => destination.emit('data', options.transform(entry))) - .once('end', () => destination.emit('end')); - destination - .once('close', () => source.destroy()); - return destination; - } - api(root, task, options) { - if (task.dynamic) { - return this._reader.dynamic(root, options); - } - return this._reader.static(task.patterns, options); - } -} -exports.default = ProviderStream; - - -/***/ }), - -/***/ "../../node_modules/globby/node_modules/fast-glob/out/providers/sync.js": -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - -Object.defineProperty(exports, "__esModule", { value: true }); -const sync_1 = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/readers/sync.js"); -const provider_1 = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/providers/provider.js"); -class ProviderSync extends provider_1.default { - constructor() { - super(...arguments); - this._reader = new sync_1.default(this._settings); - } - read(task) { - const root = this._getRootDirectory(task); - const options = this._getReaderOptions(task); - const entries = this.api(root, task, options); - return entries.map(options.transform); - } - api(root, task, options) { - if (task.dynamic) { - return this._reader.dynamic(root, options); - } - return this._reader.static(task.patterns, options); - } -} -exports.default = ProviderSync; - - -/***/ }), - -/***/ "../../node_modules/globby/node_modules/fast-glob/out/providers/transformers/entry.js": -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - -Object.defineProperty(exports, "__esModule", { value: true }); -const utils = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/utils/index.js"); -class EntryTransformer { - constructor(_settings) { - this._settings = _settings; - } - getTransformer() { - return (entry) => this._transform(entry); - } - _transform(entry) { - let filepath = entry.path; - if (this._settings.absolute) { - filepath = utils.path.makeAbsolute(this._settings.cwd, filepath); - filepath = utils.path.unixify(filepath); - } - if (this._settings.markDirectories && entry.dirent.isDirectory()) { - filepath += '/'; - } - if (!this._settings.objectMode) { - return filepath; - } - return Object.assign(Object.assign({}, entry), { path: filepath }); - } -} -exports.default = EntryTransformer; - - -/***/ }), - -/***/ "../../node_modules/globby/node_modules/fast-glob/out/readers/reader.js": -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - -Object.defineProperty(exports, "__esModule", { value: true }); -const path = __webpack_require__("path"); -const fsStat = __webpack_require__("../../node_modules/@nodelib/fs.stat/out/index.js"); -const utils = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/utils/index.js"); -class Reader { - constructor(_settings) { - this._settings = _settings; - this._fsStatSettings = new fsStat.Settings({ - followSymbolicLink: this._settings.followSymbolicLinks, - fs: this._settings.fs, - throwErrorOnBrokenSymbolicLink: this._settings.followSymbolicLinks - }); - } - _getFullEntryPath(filepath) { - return path.resolve(this._settings.cwd, filepath); - } - _makeEntry(stats, pattern) { - const entry = { - name: pattern, - path: pattern, - dirent: utils.fs.createDirentFromStats(pattern, stats) - }; - if (this._settings.stats) { - entry.stats = stats; - } - return entry; - } - _isFatalError(error) { - return !utils.errno.isEnoentCodeError(error) && !this._settings.suppressErrors; - } -} -exports.default = Reader; - - -/***/ }), - -/***/ "../../node_modules/globby/node_modules/fast-glob/out/readers/stream.js": -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - -Object.defineProperty(exports, "__esModule", { value: true }); -const stream_1 = __webpack_require__("stream"); -const fsStat = __webpack_require__("../../node_modules/@nodelib/fs.stat/out/index.js"); -const fsWalk = __webpack_require__("../../node_modules/@nodelib/fs.walk/out/index.js"); -const reader_1 = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/readers/reader.js"); -class ReaderStream extends reader_1.default { - constructor() { - super(...arguments); - this._walkStream = fsWalk.walkStream; - this._stat = fsStat.stat; - } - dynamic(root, options) { - return this._walkStream(root, options); - } - static(patterns, options) { - const filepaths = patterns.map(this._getFullEntryPath, this); - const stream = new stream_1.PassThrough({ objectMode: true }); - stream._write = (index, _enc, done) => { - return this._getEntry(filepaths[index], patterns[index], options) - .then((entry) => { - if (entry !== null && options.entryFilter(entry)) { - stream.push(entry); - } - if (index === filepaths.length - 1) { - stream.end(); - } - done(); - }) - .catch(done); - }; - for (let i = 0; i < filepaths.length; i++) { - stream.write(i); - } - return stream; - } - _getEntry(filepath, pattern, options) { - return this._getStat(filepath) - .then((stats) => this._makeEntry(stats, pattern)) - .catch((error) => { - if (options.errorFilter(error)) { - return null; - } - throw error; - }); - } - _getStat(filepath) { - return new Promise((resolve, reject) => { - this._stat(filepath, this._fsStatSettings, (error, stats) => { - return error === null ? resolve(stats) : reject(error); - }); - }); - } -} -exports.default = ReaderStream; - - -/***/ }), - -/***/ "../../node_modules/globby/node_modules/fast-glob/out/readers/sync.js": -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - -Object.defineProperty(exports, "__esModule", { value: true }); -const fsStat = __webpack_require__("../../node_modules/@nodelib/fs.stat/out/index.js"); -const fsWalk = __webpack_require__("../../node_modules/@nodelib/fs.walk/out/index.js"); -const reader_1 = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/readers/reader.js"); -class ReaderSync extends reader_1.default { - constructor() { - super(...arguments); - this._walkSync = fsWalk.walkSync; - this._statSync = fsStat.statSync; - } - dynamic(root, options) { - return this._walkSync(root, options); - } - static(patterns, options) { - const entries = []; - for (const pattern of patterns) { - const filepath = this._getFullEntryPath(pattern); - const entry = this._getEntry(filepath, pattern, options); - if (entry === null || !options.entryFilter(entry)) { - continue; - } - entries.push(entry); - } - return entries; - } - _getEntry(filepath, pattern, options) { - try { - const stats = this._getStat(filepath); - return this._makeEntry(stats, pattern); - } - catch (error) { - if (options.errorFilter(error)) { - return null; - } - throw error; - } - } - _getStat(filepath) { - return this._statSync(filepath, this._fsStatSettings); - } -} -exports.default = ReaderSync; - - -/***/ }), - -/***/ "../../node_modules/globby/node_modules/fast-glob/out/settings.js": -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - -Object.defineProperty(exports, "__esModule", { value: true }); -exports.DEFAULT_FILE_SYSTEM_ADAPTER = void 0; -const fs = __webpack_require__("fs"); -const os = __webpack_require__("os"); -/** - * The `os.cpus` method can return zero. We expect the number of cores to be greater than zero. - * https://github.com/nodejs/node/blob/7faeddf23a98c53896f8b574a6e66589e8fb1eb8/lib/os.js#L106-L107 - */ -const CPU_COUNT = Math.max(os.cpus().length, 1); -exports.DEFAULT_FILE_SYSTEM_ADAPTER = { - lstat: fs.lstat, - lstatSync: fs.lstatSync, - stat: fs.stat, - statSync: fs.statSync, - readdir: fs.readdir, - readdirSync: fs.readdirSync -}; -class Settings { - constructor(_options = {}) { - this._options = _options; - this.absolute = this._getValue(this._options.absolute, false); - this.baseNameMatch = this._getValue(this._options.baseNameMatch, false); - this.braceExpansion = this._getValue(this._options.braceExpansion, true); - this.caseSensitiveMatch = this._getValue(this._options.caseSensitiveMatch, true); - this.concurrency = this._getValue(this._options.concurrency, CPU_COUNT); - this.cwd = this._getValue(this._options.cwd, process.cwd()); - this.deep = this._getValue(this._options.deep, Infinity); - this.dot = this._getValue(this._options.dot, false); - this.extglob = this._getValue(this._options.extglob, true); - this.followSymbolicLinks = this._getValue(this._options.followSymbolicLinks, true); - this.fs = this._getFileSystemMethods(this._options.fs); - this.globstar = this._getValue(this._options.globstar, true); - this.ignore = this._getValue(this._options.ignore, []); - this.markDirectories = this._getValue(this._options.markDirectories, false); - this.objectMode = this._getValue(this._options.objectMode, false); - this.onlyDirectories = this._getValue(this._options.onlyDirectories, false); - this.onlyFiles = this._getValue(this._options.onlyFiles, true); - this.stats = this._getValue(this._options.stats, false); - this.suppressErrors = this._getValue(this._options.suppressErrors, false); - this.throwErrorOnBrokenSymbolicLink = this._getValue(this._options.throwErrorOnBrokenSymbolicLink, false); - this.unique = this._getValue(this._options.unique, true); - if (this.onlyDirectories) { - this.onlyFiles = false; - } - if (this.stats) { - this.objectMode = true; - } - } - _getValue(option, value) { - return option === undefined ? value : option; - } - _getFileSystemMethods(methods = {}) { - return Object.assign(Object.assign({}, exports.DEFAULT_FILE_SYSTEM_ADAPTER), methods); - } -} -exports.default = Settings; - - -/***/ }), - -/***/ "../../node_modules/globby/node_modules/fast-glob/out/utils/array.js": -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - -Object.defineProperty(exports, "__esModule", { value: true }); -exports.splitWhen = exports.flatten = void 0; -function flatten(items) { - return items.reduce((collection, item) => [].concat(collection, item), []); -} -exports.flatten = flatten; -function splitWhen(items, predicate) { - const result = [[]]; - let groupIndex = 0; - for (const item of items) { - if (predicate(item)) { - groupIndex++; - result[groupIndex] = []; - } - else { - result[groupIndex].push(item); - } - } - return result; -} -exports.splitWhen = splitWhen; - - -/***/ }), - -/***/ "../../node_modules/globby/node_modules/fast-glob/out/utils/errno.js": -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - -Object.defineProperty(exports, "__esModule", { value: true }); -exports.isEnoentCodeError = void 0; -function isEnoentCodeError(error) { - return error.code === 'ENOENT'; -} -exports.isEnoentCodeError = isEnoentCodeError; - - -/***/ }), - -/***/ "../../node_modules/globby/node_modules/fast-glob/out/utils/fs.js": -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - -Object.defineProperty(exports, "__esModule", { value: true }); -exports.createDirentFromStats = void 0; -class DirentFromStats { - constructor(name, stats) { - this.name = name; - this.isBlockDevice = stats.isBlockDevice.bind(stats); - this.isCharacterDevice = stats.isCharacterDevice.bind(stats); - this.isDirectory = stats.isDirectory.bind(stats); - this.isFIFO = stats.isFIFO.bind(stats); - this.isFile = stats.isFile.bind(stats); - this.isSocket = stats.isSocket.bind(stats); - this.isSymbolicLink = stats.isSymbolicLink.bind(stats); - } -} -function createDirentFromStats(name, stats) { - return new DirentFromStats(name, stats); -} -exports.createDirentFromStats = createDirentFromStats; - - -/***/ }), - -/***/ "../../node_modules/globby/node_modules/fast-glob/out/utils/index.js": -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - -Object.defineProperty(exports, "__esModule", { value: true }); -exports.string = exports.stream = exports.pattern = exports.path = exports.fs = exports.errno = exports.array = void 0; -const array = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/utils/array.js"); -exports.array = array; -const errno = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/utils/errno.js"); -exports.errno = errno; -const fs = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/utils/fs.js"); -exports.fs = fs; -const path = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/utils/path.js"); -exports.path = path; -const pattern = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/utils/pattern.js"); -exports.pattern = pattern; -const stream = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/utils/stream.js"); -exports.stream = stream; -const string = __webpack_require__("../../node_modules/globby/node_modules/fast-glob/out/utils/string.js"); -exports.string = string; - - -/***/ }), - -/***/ "../../node_modules/globby/node_modules/fast-glob/out/utils/path.js": -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - -Object.defineProperty(exports, "__esModule", { value: true }); -exports.removeLeadingDotSegment = exports.escape = exports.makeAbsolute = exports.unixify = void 0; -const path = __webpack_require__("path"); -const LEADING_DOT_SEGMENT_CHARACTERS_COUNT = 2; // ./ or .\\ -const UNESCAPED_GLOB_SYMBOLS_RE = /(\\?)([()*?[\]{|}]|^!|[!+@](?=\())/g; -/** - * Designed to work only with simple paths: `dir\\file`. - */ -function unixify(filepath) { - return filepath.replace(/\\/g, '/'); -} -exports.unixify = unixify; -function makeAbsolute(cwd, filepath) { - return path.resolve(cwd, filepath); -} -exports.makeAbsolute = makeAbsolute; -function escape(pattern) { - return pattern.replace(UNESCAPED_GLOB_SYMBOLS_RE, '\\$2'); -} -exports.escape = escape; -function removeLeadingDotSegment(entry) { - // We do not use `startsWith` because this is 10x slower than current implementation for some cases. - // eslint-disable-next-line @typescript-eslint/prefer-string-starts-ends-with - if (entry.charAt(0) === '.') { - const secondCharactery = entry.charAt(1); - if (secondCharactery === '/' || secondCharactery === '\\') { - return entry.slice(LEADING_DOT_SEGMENT_CHARACTERS_COUNT); - } - } - return entry; -} -exports.removeLeadingDotSegment = removeLeadingDotSegment; - - -/***/ }), + // the noGlobStar pattern exits the inGlobStar state + this._process(noGlobStar, index, false) -/***/ "../../node_modules/globby/node_modules/fast-glob/out/utils/pattern.js": -/***/ (function(module, exports, __webpack_require__) { + var len = entries.length + var isSym = this.symlinks[abs] -"use strict"; + // If it's a symlink, and we're in a globstar, then stop + if (isSym && inGlobStar) + return -Object.defineProperty(exports, "__esModule", { value: true }); -exports.matchAny = exports.convertPatternsToRe = exports.makeRe = exports.getPatternParts = exports.expandBraceExpansion = exports.expandPatternsWithBraceExpansion = exports.isAffectDepthOfReadingPattern = exports.endsWithSlashGlobStar = exports.hasGlobStar = exports.getBaseDirectory = exports.isPatternRelatedToParentDirectory = exports.getPatternsOutsideCurrentDirectory = exports.getPatternsInsideCurrentDirectory = exports.getPositivePatterns = exports.getNegativePatterns = exports.isPositivePattern = exports.isNegativePattern = exports.convertToNegativePattern = exports.convertToPositivePattern = exports.isDynamicPattern = exports.isStaticPattern = void 0; -const path = __webpack_require__("path"); -const globParent = __webpack_require__("../../node_modules/glob-parent/index.js"); -const micromatch = __webpack_require__("../../node_modules/globby/node_modules/micromatch/index.js"); -const GLOBSTAR = '**'; -const ESCAPE_SYMBOL = '\\'; -const COMMON_GLOB_SYMBOLS_RE = /[*?]|^!/; -const REGEX_CHARACTER_CLASS_SYMBOLS_RE = /\[.*]/; -const REGEX_GROUP_SYMBOLS_RE = /(?:^|[^!*+?@])\(.*\|.*\)/; -const GLOB_EXTENSION_SYMBOLS_RE = /[!*+?@]\(.*\)/; -const BRACE_EXPANSIONS_SYMBOLS_RE = /{.*(?:,|\.\.).*}/; -function isStaticPattern(pattern, options = {}) { - return !isDynamicPattern(pattern, options); -} -exports.isStaticPattern = isStaticPattern; -function isDynamicPattern(pattern, options = {}) { - /** - * A special case with an empty string is necessary for matching patterns that start with a forward slash. - * An empty string cannot be a dynamic pattern. - * For example, the pattern `/lib/*` will be spread into parts: '', 'lib', '*'. - */ - if (pattern === '') { - return false; - } - /** - * When the `caseSensitiveMatch` option is disabled, all patterns must be marked as dynamic, because we cannot check - * filepath directly (without read directory). - */ - if (options.caseSensitiveMatch === false || pattern.includes(ESCAPE_SYMBOL)) { - return true; - } - if (COMMON_GLOB_SYMBOLS_RE.test(pattern) || REGEX_CHARACTER_CLASS_SYMBOLS_RE.test(pattern) || REGEX_GROUP_SYMBOLS_RE.test(pattern)) { - return true; - } - if (options.extglob !== false && GLOB_EXTENSION_SYMBOLS_RE.test(pattern)) { - return true; - } - if (options.braceExpansion !== false && BRACE_EXPANSIONS_SYMBOLS_RE.test(pattern)) { - return true; - } - return false; -} -exports.isDynamicPattern = isDynamicPattern; -function convertToPositivePattern(pattern) { - return isNegativePattern(pattern) ? pattern.slice(1) : pattern; -} -exports.convertToPositivePattern = convertToPositivePattern; -function convertToNegativePattern(pattern) { - return '!' + pattern; -} -exports.convertToNegativePattern = convertToNegativePattern; -function isNegativePattern(pattern) { - return pattern.startsWith('!') && pattern[1] !== '('; -} -exports.isNegativePattern = isNegativePattern; -function isPositivePattern(pattern) { - return !isNegativePattern(pattern); -} -exports.isPositivePattern = isPositivePattern; -function getNegativePatterns(patterns) { - return patterns.filter(isNegativePattern); -} -exports.getNegativePatterns = getNegativePatterns; -function getPositivePatterns(patterns) { - return patterns.filter(isPositivePattern); -} -exports.getPositivePatterns = getPositivePatterns; -/** - * Returns patterns that can be applied inside the current directory. - * - * @example - * // ['./*', '*', 'a/*'] - * getPatternsInsideCurrentDirectory(['./*', '*', 'a/*', '../*', './../*']) - */ -function getPatternsInsideCurrentDirectory(patterns) { - return patterns.filter((pattern) => !isPatternRelatedToParentDirectory(pattern)); -} -exports.getPatternsInsideCurrentDirectory = getPatternsInsideCurrentDirectory; -/** - * Returns patterns to be expanded relative to (outside) the current directory. - * - * @example - * // ['../*', './../*'] - * getPatternsInsideCurrentDirectory(['./*', '*', 'a/*', '../*', './../*']) - */ -function getPatternsOutsideCurrentDirectory(patterns) { - return patterns.filter(isPatternRelatedToParentDirectory); -} -exports.getPatternsOutsideCurrentDirectory = getPatternsOutsideCurrentDirectory; -function isPatternRelatedToParentDirectory(pattern) { - return pattern.startsWith('..') || pattern.startsWith('./..'); -} -exports.isPatternRelatedToParentDirectory = isPatternRelatedToParentDirectory; -function getBaseDirectory(pattern) { - return globParent(pattern, { flipBackslashes: false }); -} -exports.getBaseDirectory = getBaseDirectory; -function hasGlobStar(pattern) { - return pattern.includes(GLOBSTAR); -} -exports.hasGlobStar = hasGlobStar; -function endsWithSlashGlobStar(pattern) { - return pattern.endsWith('/' + GLOBSTAR); -} -exports.endsWithSlashGlobStar = endsWithSlashGlobStar; -function isAffectDepthOfReadingPattern(pattern) { - const basename = path.basename(pattern); - return endsWithSlashGlobStar(pattern) || isStaticPattern(basename); -} -exports.isAffectDepthOfReadingPattern = isAffectDepthOfReadingPattern; -function expandPatternsWithBraceExpansion(patterns) { - return patterns.reduce((collection, pattern) => { - return collection.concat(expandBraceExpansion(pattern)); - }, []); -} -exports.expandPatternsWithBraceExpansion = expandPatternsWithBraceExpansion; -function expandBraceExpansion(pattern) { - return micromatch.braces(pattern, { - expand: true, - nodupes: true - }); -} -exports.expandBraceExpansion = expandBraceExpansion; -function getPatternParts(pattern, options) { - let { parts } = micromatch.scan(pattern, Object.assign(Object.assign({}, options), { parts: true })); - /** - * The scan method returns an empty array in some cases. - * See micromatch/picomatch#58 for more details. - */ - if (parts.length === 0) { - parts = [pattern]; - } - /** - * The scan method does not return an empty part for the pattern with a forward slash. - * This is another part of micromatch/picomatch#58. - */ - if (parts[0].startsWith('/')) { - parts[0] = parts[0].slice(1); - parts.unshift(''); - } - return parts; -} -exports.getPatternParts = getPatternParts; -function makeRe(pattern, options) { - return micromatch.makeRe(pattern, options); -} -exports.makeRe = makeRe; -function convertPatternsToRe(patterns, options) { - return patterns.map((pattern) => makeRe(pattern, options)); -} -exports.convertPatternsToRe = convertPatternsToRe; -function matchAny(entry, patternsRe) { - return patternsRe.some((patternRe) => patternRe.test(entry)); + for (var i = 0; i < len; i++) { + var e = entries[i] + if (e.charAt(0) === '.' && !this.dot) + continue + + // these two cases enter the inGlobStar state + var instead = gspref.concat(entries[i], remainWithoutGlobStar) + this._process(instead, index, true) + + var below = gspref.concat(entries[i], remain) + this._process(below, index, true) + } } -exports.matchAny = matchAny; +GlobSync.prototype._processSimple = function (prefix, index) { + // XXX review this. Shouldn't it be doing the mounting etc + // before doing stat? kinda weird? + var exists = this._stat(prefix) -/***/ }), + if (!this.matches[index]) + this.matches[index] = Object.create(null) -/***/ "../../node_modules/globby/node_modules/fast-glob/out/utils/stream.js": -/***/ (function(module, exports, __webpack_require__) { + // If it doesn't exist, then just mark the lack of results + if (!exists) + return -"use strict"; + if (prefix && isAbsolute(prefix) && !this.nomount) { + var trail = /[\/\\]$/.test(prefix) + if (prefix.charAt(0) === '/') { + prefix = path.join(this.root, prefix) + } else { + prefix = path.resolve(this.root, prefix) + if (trail) + prefix += '/' + } + } -Object.defineProperty(exports, "__esModule", { value: true }); -exports.merge = void 0; -const merge2 = __webpack_require__("../../node_modules/merge2/index.js"); -function merge(streams) { - const mergedStream = merge2(streams); - streams.forEach((stream) => { - stream.once('error', (error) => mergedStream.emit('error', error)); - }); - mergedStream.once('close', () => propagateCloseEventToSources(streams)); - mergedStream.once('end', () => propagateCloseEventToSources(streams)); - return mergedStream; -} -exports.merge = merge; -function propagateCloseEventToSources(streams) { - streams.forEach((stream) => stream.emit('close')); + if (process.platform === 'win32') + prefix = prefix.replace(/\\/g, '/') + + // Mark this as a match + this._emitMatch(index, prefix) } +// Returns either 'DIR', 'FILE', or false +GlobSync.prototype._stat = function (f) { + var abs = this._makeAbs(f) + var needDir = f.slice(-1) === '/' -/***/ }), + if (f.length > this.maxLength) + return false -/***/ "../../node_modules/globby/node_modules/fast-glob/out/utils/string.js": -/***/ (function(module, exports, __webpack_require__) { + if (!this.stat && ownProp(this.cache, abs)) { + var c = this.cache[abs] -"use strict"; + if (Array.isArray(c)) + c = 'DIR' -Object.defineProperty(exports, "__esModule", { value: true }); -exports.isEmpty = exports.isString = void 0; -function isString(input) { - return typeof input === 'string'; + // It exists, but maybe not how we need it + if (!needDir || c === 'DIR') + return c + + if (needDir && c === 'FILE') + return false + + // otherwise we have to stat, because maybe c=true + // if we know it exists, but not what it is. + } + + var exists + var stat = this.statCache[abs] + if (!stat) { + var lstat + try { + lstat = this.fs.lstatSync(abs) + } catch (er) { + if (er && (er.code === 'ENOENT' || er.code === 'ENOTDIR')) { + this.statCache[abs] = false + return false + } + } + + if (lstat && lstat.isSymbolicLink()) { + try { + stat = this.fs.statSync(abs) + } catch (er) { + stat = lstat + } + } else { + stat = lstat + } + } + + this.statCache[abs] = stat + + var c = true + if (stat) + c = stat.isDirectory() ? 'DIR' : 'FILE' + + this.cache[abs] = this.cache[abs] || c + + if (needDir && c === 'FILE') + return false + + return c } -exports.isString = isString; -function isEmpty(input) { - return input === ''; + +GlobSync.prototype._mark = function (p) { + return common.mark(this, p) +} + +GlobSync.prototype._makeAbs = function (f) { + return common.makeAbs(this, f) } -exports.isEmpty = isEmpty; /***/ }), -/***/ "../../node_modules/globby/node_modules/micromatch/index.js": +/***/ "../../node_modules/globby/gitignore.js": /***/ (function(module, exports, __webpack_require__) { "use strict"; +const {promisify} = __webpack_require__("util"); +const fs = __webpack_require__("fs"); +const path = __webpack_require__("path"); +const fastGlob = __webpack_require__("../../node_modules/fast-glob/out/index.js"); +const gitIgnore = __webpack_require__("../../node_modules/ignore/index.js"); +const slash = __webpack_require__("../../node_modules/slash/index.js"); -const util = __webpack_require__("util"); -const braces = __webpack_require__("../../node_modules/braces/index.js"); -const picomatch = __webpack_require__("../../node_modules/picomatch/index.js"); -const utils = __webpack_require__("../../node_modules/picomatch/lib/utils.js"); -const isEmptyString = val => val === '' || val === './'; +const DEFAULT_IGNORE = [ + '**/node_modules/**', + '**/flow-typed/**', + '**/coverage/**', + '**/.git' +]; -/** - * Returns an array of strings that match one or more glob patterns. - * - * ```js - * const mm = require('micromatch'); - * // mm(list, patterns[, options]); - * - * console.log(mm(['a.js', 'a.txt'], ['*.js'])); - * //=> [ 'a.js' ] - * ``` - * @param {String|Array} `list` List of strings to match. - * @param {String|Array} `patterns` One or more glob patterns to use for matching. - * @param {Object} `options` See available [options](#options) - * @return {Array} Returns an array of matches - * @summary false - * @api public - */ +const readFileP = promisify(fs.readFile); -const micromatch = (list, patterns, options) => { - patterns = [].concat(patterns); - list = [].concat(list); +const mapGitIgnorePatternTo = base => ignore => { + if (ignore.startsWith('!')) { + return '!' + path.posix.join(base, ignore.slice(1)); + } - let omit = new Set(); - let keep = new Set(); - let items = new Set(); - let negatives = 0; + return path.posix.join(base, ignore); +}; - let onResult = state => { - items.add(state.output); - if (options && options.onResult) { - options.onResult(state); - } - }; +const parseGitIgnore = (content, options) => { + const base = slash(path.relative(options.cwd, path.dirname(options.fileName))); - for (let i = 0; i < patterns.length; i++) { - let isMatch = picomatch(String(patterns[i]), { ...options, onResult }, true); - let negated = isMatch.state.negated || isMatch.state.negatedExtglob; - if (negated) negatives++; + return content + .split(/\r?\n/) + .filter(Boolean) + .filter(line => !line.startsWith('#')) + .map(mapGitIgnorePatternTo(base)); +}; - for (let item of list) { - let matched = isMatch(item, true); +const reduceIgnore = files => { + const ignores = gitIgnore(); + for (const file of files) { + ignores.add(parseGitIgnore(file.content, { + cwd: file.cwd, + fileName: file.filePath + })); + } - let match = negated ? !matched.isMatch : matched.isMatch; - if (!match) continue; + return ignores; +}; - if (negated) { - omit.add(matched.output); - } else { - omit.delete(matched.output); - keep.add(matched.output); - } - } - } +const ensureAbsolutePathForCwd = (cwd, p) => { + cwd = slash(cwd); + if (path.isAbsolute(p)) { + if (slash(p).startsWith(cwd)) { + return p; + } - let result = negatives === patterns.length ? [...items] : [...keep]; - let matches = result.filter(item => !omit.has(item)); + throw new Error(`Path ${p} is not in cwd ${cwd}`); + } - if (options && matches.length === 0) { - if (options.failglob === true) { - throw new Error(`No matches found for "${patterns.join(', ')}"`); - } + return path.join(cwd, p); +}; - if (options.nonull === true || options.nullglob === true) { - return options.unescape ? patterns.map(p => p.replace(/\\/g, '')) : patterns; - } - } +const getIsIgnoredPredecate = (ignores, cwd) => { + return p => ignores.ignores(slash(path.relative(cwd, ensureAbsolutePathForCwd(cwd, p.path || p)))); +}; - return matches; +const getFile = async (file, cwd) => { + const filePath = path.join(cwd, file); + const content = await readFileP(filePath, 'utf8'); + + return { + cwd, + filePath, + content + }; }; -/** - * Backwards compatibility - */ +const getFileSync = (file, cwd) => { + const filePath = path.join(cwd, file); + const content = fs.readFileSync(filePath, 'utf8'); -micromatch.match = micromatch; + return { + cwd, + filePath, + content + }; +}; -/** - * Returns a matcher function from the given glob `pattern` and `options`. - * The returned function takes a string to match as its only argument and returns - * true if the string is a match. - * - * ```js - * const mm = require('micromatch'); - * // mm.matcher(pattern[, options]); - * - * const isMatch = mm.matcher('*.!(*a)'); - * console.log(isMatch('a.a')); //=> false - * console.log(isMatch('a.b')); //=> true - * ``` - * @param {String} `pattern` Glob pattern - * @param {Object} `options` - * @return {Function} Returns a matcher function. - * @api public - */ +const normalizeOptions = ({ + ignore = [], + cwd = slash(process.cwd()) +} = {}) => { + return {ignore, cwd}; +}; -micromatch.matcher = (pattern, options) => picomatch(pattern, options); +module.exports = async options => { + options = normalizeOptions(options); -/** - * Returns true if **any** of the given glob `patterns` match the specified `string`. - * - * ```js - * const mm = require('micromatch'); - * // mm.isMatch(string, patterns[, options]); - * - * console.log(mm.isMatch('a.a', ['b.*', '*.a'])); //=> true - * console.log(mm.isMatch('a.a', 'b.*')); //=> false - * ``` - * @param {String} `str` The string to test. - * @param {String|Array} `patterns` One or more glob patterns to use for matching. - * @param {Object} `[options]` See available [options](#options). - * @return {Boolean} Returns true if any patterns match `str` - * @api public - */ + const paths = await fastGlob('**/.gitignore', { + ignore: DEFAULT_IGNORE.concat(options.ignore), + cwd: options.cwd + }); -micromatch.isMatch = (str, patterns, options) => picomatch(patterns, options)(str); + const files = await Promise.all(paths.map(file => getFile(file, options.cwd))); + const ignores = reduceIgnore(files); -/** - * Backwards compatibility - */ + return getIsIgnoredPredecate(ignores, options.cwd); +}; -micromatch.any = micromatch.isMatch; +module.exports.sync = options => { + options = normalizeOptions(options); -/** - * Returns a list of strings that _**do not match any**_ of the given `patterns`. - * - * ```js - * const mm = require('micromatch'); - * // mm.not(list, patterns[, options]); - * - * console.log(mm.not(['a.a', 'b.b', 'c.c'], '*.a')); - * //=> ['b.b', 'c.c'] - * ``` - * @param {Array} `list` Array of strings to match. - * @param {String|Array} `patterns` One or more glob pattern to use for matching. - * @param {Object} `options` See available [options](#options) for changing how matches are performed - * @return {Array} Returns an array of strings that **do not match** the given patterns. - * @api public - */ + const paths = fastGlob.sync('**/.gitignore', { + ignore: DEFAULT_IGNORE.concat(options.ignore), + cwd: options.cwd + }); -micromatch.not = (list, patterns, options = {}) => { - patterns = [].concat(patterns).map(String); - let result = new Set(); - let items = []; + const files = paths.map(file => getFileSync(file, options.cwd)); + const ignores = reduceIgnore(files); - let onResult = state => { - if (options.onResult) options.onResult(state); - items.push(state.output); - }; + return getIsIgnoredPredecate(ignores, options.cwd); +}; - let matches = micromatch(list, patterns, { ...options, onResult }); - for (let item of items) { - if (!matches.includes(item)) { - result.add(item); - } - } - return [...result]; -}; +/***/ }), -/** - * Returns true if the given `string` contains the given pattern. Similar - * to [.isMatch](#isMatch) but the pattern can match any part of the string. - * - * ```js - * var mm = require('micromatch'); - * // mm.contains(string, pattern[, options]); - * - * console.log(mm.contains('aa/bb/cc', '*b')); - * //=> true - * console.log(mm.contains('aa/bb/cc', '*d')); - * //=> false - * ``` - * @param {String} `str` The string to match. - * @param {String|Array} `patterns` Glob pattern to use for matching. - * @param {Object} `options` See available [options](#options) for changing how matches are performed - * @return {Boolean} Returns true if any of the patterns matches any part of `str`. - * @api public - */ +/***/ "../../node_modules/globby/index.js": +/***/ (function(module, exports, __webpack_require__) { -micromatch.contains = (str, pattern, options) => { - if (typeof str !== 'string') { - throw new TypeError(`Expected a string: "${util.inspect(str)}"`); - } +"use strict"; - if (Array.isArray(pattern)) { - return pattern.some(p => micromatch.contains(str, p, options)); - } +const fs = __webpack_require__("fs"); +const arrayUnion = __webpack_require__("../../node_modules/array-union/index.js"); +const merge2 = __webpack_require__("../../node_modules/merge2/index.js"); +const fastGlob = __webpack_require__("../../node_modules/fast-glob/out/index.js"); +const dirGlob = __webpack_require__("../../node_modules/dir-glob/index.js"); +const gitignore = __webpack_require__("../../node_modules/globby/gitignore.js"); +const {FilterStream, UniqueStream} = __webpack_require__("../../node_modules/globby/stream-utils.js"); - if (typeof pattern === 'string') { - if (isEmptyString(str) || isEmptyString(pattern)) { - return false; - } +const DEFAULT_FILTER = () => false; - if (str.includes(pattern) || (str.startsWith('./') && str.slice(2).includes(pattern))) { - return true; - } - } +const isNegative = pattern => pattern[0] === '!'; - return micromatch.isMatch(str, pattern, { ...options, contains: true }); +const assertPatternsInput = patterns => { + if (!patterns.every(pattern => typeof pattern === 'string')) { + throw new TypeError('Patterns must be a string or an array of strings'); + } }; -/** - * Filter the keys of the given object with the given `glob` pattern - * and `options`. Does not attempt to match nested keys. If you need this feature, - * use [glob-object][] instead. - * - * ```js - * const mm = require('micromatch'); - * // mm.matchKeys(object, patterns[, options]); - * - * const obj = { aa: 'a', ab: 'b', ac: 'c' }; - * console.log(mm.matchKeys(obj, '*b')); - * //=> { ab: 'b' } - * ``` - * @param {Object} `object` The object with keys to filter. - * @param {String|Array} `patterns` One or more glob patterns to use for matching. - * @param {Object} `options` See available [options](#options) for changing how matches are performed - * @return {Object} Returns an object with only keys that match the given patterns. - * @api public - */ +const checkCwdOption = (options = {}) => { + if (!options.cwd) { + return; + } -micromatch.matchKeys = (obj, patterns, options) => { - if (!utils.isObject(obj)) { - throw new TypeError('Expected the first argument to be an object'); - } - let keys = micromatch(Object.keys(obj), patterns, options); - let res = {}; - for (let key of keys) res[key] = obj[key]; - return res; + let stat; + try { + stat = fs.statSync(options.cwd); + } catch { + return; + } + + if (!stat.isDirectory()) { + throw new Error('The `cwd` option must be a path to a directory'); + } }; -/** - * Returns true if some of the strings in the given `list` match any of the given glob `patterns`. - * - * ```js - * const mm = require('micromatch'); - * // mm.some(list, patterns[, options]); - * - * console.log(mm.some(['foo.js', 'bar.js'], ['*.js', '!foo.js'])); - * // true - * console.log(mm.some(['foo.js'], ['*.js', '!foo.js'])); - * // false - * ``` - * @param {String|Array} `list` The string or array of strings to test. Returns as soon as the first match is found. - * @param {String|Array} `patterns` One or more glob patterns to use for matching. - * @param {Object} `options` See available [options](#options) for changing how matches are performed - * @return {Boolean} Returns true if any `patterns` matches any of the strings in `list` - * @api public - */ +const getPathString = p => p.stats instanceof fs.Stats ? p.path : p; -micromatch.some = (list, patterns, options) => { - let items = [].concat(list); +const generateGlobTasks = (patterns, taskOptions) => { + patterns = arrayUnion([].concat(patterns)); + assertPatternsInput(patterns); + checkCwdOption(taskOptions); - for (let pattern of [].concat(patterns)) { - let isMatch = picomatch(String(pattern), options); - if (items.some(item => isMatch(item))) { - return true; - } - } - return false; -}; + const globTasks = []; -/** - * Returns true if every string in the given `list` matches - * any of the given glob `patterns`. - * - * ```js - * const mm = require('micromatch'); - * // mm.every(list, patterns[, options]); - * - * console.log(mm.every('foo.js', ['foo.js'])); - * // true - * console.log(mm.every(['foo.js', 'bar.js'], ['*.js'])); - * // true - * console.log(mm.every(['foo.js', 'bar.js'], ['*.js', '!foo.js'])); - * // false - * console.log(mm.every(['foo.js'], ['*.js', '!foo.js'])); - * // false - * ``` - * @param {String|Array} `list` The string or array of strings to test. - * @param {String|Array} `patterns` One or more glob patterns to use for matching. - * @param {Object} `options` See available [options](#options) for changing how matches are performed - * @return {Boolean} Returns true if all `patterns` matches all of the strings in `list` - * @api public - */ + taskOptions = { + ignore: [], + expandDirectories: true, + ...taskOptions + }; -micromatch.every = (list, patterns, options) => { - let items = [].concat(list); + for (const [index, pattern] of patterns.entries()) { + if (isNegative(pattern)) { + continue; + } - for (let pattern of [].concat(patterns)) { - let isMatch = picomatch(String(pattern), options); - if (!items.every(item => isMatch(item))) { - return false; - } - } - return true; + const ignore = patterns + .slice(index) + .filter(pattern => isNegative(pattern)) + .map(pattern => pattern.slice(1)); + + const options = { + ...taskOptions, + ignore: taskOptions.ignore.concat(ignore) + }; + + globTasks.push({pattern, options}); + } + + return globTasks; }; -/** - * Returns true if **all** of the given `patterns` match - * the specified string. - * - * ```js - * const mm = require('micromatch'); - * // mm.all(string, patterns[, options]); - * - * console.log(mm.all('foo.js', ['foo.js'])); - * // true - * - * console.log(mm.all('foo.js', ['*.js', '!foo.js'])); - * // false - * - * console.log(mm.all('foo.js', ['*.js', 'foo.js'])); - * // true - * - * console.log(mm.all('foo.js', ['*.js', 'f*', '*o*', '*o.js'])); - * // true - * ``` - * @param {String|Array} `str` The string to test. - * @param {String|Array} `patterns` One or more glob patterns to use for matching. - * @param {Object} `options` See available [options](#options) for changing how matches are performed - * @return {Boolean} Returns true if any patterns match `str` - * @api public - */ +const globDirs = (task, fn) => { + let options = {}; + if (task.options.cwd) { + options.cwd = task.options.cwd; + } -micromatch.all = (str, patterns, options) => { - if (typeof str !== 'string') { - throw new TypeError(`Expected a string: "${util.inspect(str)}"`); - } + if (Array.isArray(task.options.expandDirectories)) { + options = { + ...options, + files: task.options.expandDirectories + }; + } else if (typeof task.options.expandDirectories === 'object') { + options = { + ...options, + ...task.options.expandDirectories + }; + } - return [].concat(patterns).every(p => picomatch(p, options)(str)); + return fn(task.pattern, options); }; -/** - * Returns an array of matches captured by `pattern` in `string, or `null` if the pattern did not match. - * - * ```js - * const mm = require('micromatch'); - * // mm.capture(pattern, string[, options]); - * - * console.log(mm.capture('test/*.js', 'test/foo.js')); - * //=> ['foo'] - * console.log(mm.capture('test/*.js', 'foo/bar.css')); - * //=> null - * ``` - * @param {String} `glob` Glob pattern to use for matching. - * @param {String} `input` String to match - * @param {Object} `options` See available [options](#options) for changing how matches are performed - * @return {Array|null} Returns an array of captures if the input matches the glob pattern, otherwise `null`. - * @api public - */ +const getPattern = (task, fn) => task.options.expandDirectories ? globDirs(task, fn) : [task.pattern]; -micromatch.capture = (glob, input, options) => { - let posix = utils.isWindows(options); - let regex = picomatch.makeRe(String(glob), { ...options, capture: true }); - let match = regex.exec(posix ? utils.toPosixSlashes(input) : input); +const getFilterSync = options => { + return options && options.gitignore ? + gitignore.sync({cwd: options.cwd, ignore: options.ignore}) : + DEFAULT_FILTER; +}; - if (match) { - return match.slice(1).map(v => v === void 0 ? '' : v); - } +const globToTask = task => glob => { + const {options} = task; + if (options.ignore && Array.isArray(options.ignore) && options.expandDirectories) { + options.ignore = dirGlob.sync(options.ignore); + } + + return { + pattern: glob, + options + }; }; -/** - * Create a regular expression from the given glob `pattern`. - * - * ```js - * const mm = require('micromatch'); - * // mm.makeRe(pattern[, options]); - * - * console.log(mm.makeRe('*.js')); - * //=> /^(?:(\.[\\\/])?(?!\.)(?=.)[^\/]*?\.js)$/ - * ``` - * @param {String} `pattern` A glob pattern to convert to regex. - * @param {Object} `options` - * @return {RegExp} Returns a regex created from the given pattern. - * @api public - */ +module.exports = async (patterns, options) => { + const globTasks = generateGlobTasks(patterns, options); -micromatch.makeRe = (...args) => picomatch.makeRe(...args); + const getFilter = async () => { + return options && options.gitignore ? + gitignore({cwd: options.cwd, ignore: options.ignore}) : + DEFAULT_FILTER; + }; -/** - * Scan a glob pattern to separate the pattern into segments. Used - * by the [split](#split) method. - * - * ```js - * const mm = require('micromatch'); - * const state = mm.scan(pattern[, options]); - * ``` - * @param {String} `pattern` - * @param {Object} `options` - * @return {Object} Returns an object with - * @api public - */ + const getTasks = async () => { + const tasks = await Promise.all(globTasks.map(async task => { + const globs = await getPattern(task, dirGlob); + return Promise.all(globs.map(globToTask(task))); + })); -micromatch.scan = (...args) => picomatch.scan(...args); + return arrayUnion(...tasks); + }; -/** - * Parse a glob pattern to create the source string for a regular - * expression. - * - * ```js - * const mm = require('micromatch'); - * const state = mm(pattern[, options]); - * ``` - * @param {String} `glob` - * @param {Object} `options` - * @return {Object} Returns an object with useful properties and output to be used as regex source string. - * @api public - */ + const [filter, tasks] = await Promise.all([getFilter(), getTasks()]); + const paths = await Promise.all(tasks.map(task => fastGlob(task.pattern, task.options))); -micromatch.parse = (patterns, options) => { - let res = []; - for (let pattern of [].concat(patterns || [])) { - for (let str of braces(String(pattern), options)) { - res.push(picomatch.parse(str, options)); - } - } - return res; + return arrayUnion(...paths).filter(path_ => !filter(getPathString(path_))); }; -/** - * Process the given brace `pattern`. - * - * ```js - * const { braces } = require('micromatch'); - * console.log(braces('foo/{a,b,c}/bar')); - * //=> [ 'foo/(a|b|c)/bar' ] - * - * console.log(braces('foo/{a,b,c}/bar', { expand: true })); - * //=> [ 'foo/a/bar', 'foo/b/bar', 'foo/c/bar' ] - * ``` - * @param {String} `pattern` String with brace pattern to process. - * @param {Object} `options` Any [options](#options) to change how expansion is performed. See the [braces][] library for all available options. - * @return {Array} - * @api public - */ +module.exports.sync = (patterns, options) => { + const globTasks = generateGlobTasks(patterns, options); -micromatch.braces = (pattern, options) => { - if (typeof pattern !== 'string') throw new TypeError('Expected a string'); - if ((options && options.nobrace === true) || !/\{.*\}/.test(pattern)) { - return [pattern]; - } - return braces(pattern, options); + const tasks = []; + for (const task of globTasks) { + const newTask = getPattern(task, dirGlob.sync).map(globToTask(task)); + tasks.push(...newTask); + } + + const filter = getFilterSync(options); + + let matches = []; + for (const task of tasks) { + matches = arrayUnion(matches, fastGlob.sync(task.pattern, task.options)); + } + + return matches.filter(path_ => !filter(path_)); }; -/** - * Expand braces - */ +module.exports.stream = (patterns, options) => { + const globTasks = generateGlobTasks(patterns, options); -micromatch.braceExpand = (pattern, options) => { - if (typeof pattern !== 'string') throw new TypeError('Expected a string'); - return micromatch.braces(pattern, { ...options, expand: true }); + const tasks = []; + for (const task of globTasks) { + const newTask = getPattern(task, dirGlob.sync).map(globToTask(task)); + tasks.push(...newTask); + } + + const filter = getFilterSync(options); + const filterStream = new FilterStream(p => !filter(p)); + const uniqueStream = new UniqueStream(); + + return merge2(tasks.map(task => fastGlob.stream(task.pattern, task.options))) + .pipe(filterStream) + .pipe(uniqueStream); }; -/** - * Expose micromatch - */ +module.exports.generateGlobTasks = generateGlobTasks; -module.exports = micromatch; +module.exports.hasMagic = (patterns, options) => [] + .concat(patterns) + .some(pattern => fastGlob.isDynamicPattern(pattern, options)); + +module.exports.gitignore = gitignore; /***/ }), diff --git a/packages/kbn-pm/webpack.config.js b/packages/kbn-pm/webpack.config.js index 73431203ecb77..60059ac038e79 100644 --- a/packages/kbn-pm/webpack.config.js +++ b/packages/kbn-pm/webpack.config.js @@ -37,22 +37,6 @@ module.exports = { ], exclude: /node_modules/, }, - // Removing an unnecessary require from - // https://github.com/ForbesLindesay/spawn-sync/blob/8ba6d1bd032917ff5f0cf68508b91bb628d16336/index.js#L3 - // - // This require would cause warnings when building with Webpack, and it's - // only required for Node <= 0.12. - { - test: /spawn-sync\/index\.js$/, - use: { - loader: 'string-replace-loader', - options: { - search: ` || require('./lib/spawn-sync')`, - replace: '', - strict: true, - }, - }, - }, // In order to make it work with Node 10 we had the need to upgrade // the package cpy to a version >= 7.0.0. In this version cpy is // using the new globby that relies in the fast-glob which relies diff --git a/packages/kbn-securitysolution-t-grid/src/mock/mock_event_details.ts b/packages/kbn-securitysolution-t-grid/src/mock/mock_event_details.ts index 93e3cd2a4ce02..8f756842e4b5b 100644 --- a/packages/kbn-securitysolution-t-grid/src/mock/mock_event_details.ts +++ b/packages/kbn-securitysolution-t-grid/src/mock/mock_event_details.ts @@ -292,37 +292,17 @@ export const eventDetailsFormattedFields = [ }, { category: 'threat', - field: 'threat.enrichments.lazer.great.field', - values: ['grrrrr', 'grrrrr_2'], - originalValue: ['grrrrr', 'grrrrr_2'], - isObjectArray: false, - }, - { - category: 'threat', - field: 'threat.enrichments.lazer.great.field.wowoe.fooooo', - values: ['grrrrr'], - originalValue: ['grrrrr'], - isObjectArray: false, - }, - { - category: 'threat', - field: 'threat.enrichments.lazer.great.field.astring', - values: ['cool'], - originalValue: ['cool'], - isObjectArray: false, - }, - { - category: 'threat', - field: 'threat.enrichments.lazer.great.field.aNumber', - values: ['1'], - originalValue: ['1'], - isObjectArray: false, - }, - { - category: 'threat', - field: 'threat.enrichments.lazer.great.field.neat', - values: ['true'], - originalValue: ['true'], - isObjectArray: false, + field: 'threat.enrichments.lazer', + values: [ + '{"great.field":["grrrrr"]}', + '{"great.field":["grrrrr_2"]}', + '{"great.field":[{"wowoe":[{"fooooo":["grrrrr"]}],"astring":"cool","aNumber":1,"neat":true}]}', + ], + originalValue: [ + '{"great.field":["grrrrr"]}', + '{"great.field":["grrrrr_2"]}', + '{"great.field":[{"wowoe":[{"fooooo":["grrrrr"]}],"astring":"cool","aNumber":1,"neat":true}]}', + ], + isObjectArray: true, }, ]; diff --git a/packages/kbn-shared-ux-components/BUILD.bazel b/packages/kbn-shared-ux-components/BUILD.bazel index 03468daf75fb8..5739076517f0b 100644 --- a/packages/kbn-shared-ux-components/BUILD.bazel +++ b/packages/kbn-shared-ux-components/BUILD.bazel @@ -40,23 +40,24 @@ NPM_MODULE_EXTRA_FILES = [ # "@npm//name-of-package" # eg. "@npm//lodash" RUNTIME_DEPS = [ - "//packages/kbn-i18n-react", - "//packages/kbn-i18n", - "//packages/shared-ux/avatar/solution", - "//packages/shared-ux/link/redirect_app", - "//packages/shared-ux/prompt/no_data_views", - "//packages/shared-ux/card/no_data", - "//packages/kbn-shared-ux-services", - "//packages/kbn-shared-ux-storybook", - "//packages/kbn-shared-ux-utility", "@npm//@elastic/eui", - "@npm//@emotion/react", "@npm//@emotion/css", + "@npm//@emotion/react", "@npm//classnames", "@npm//react-use", "@npm//react", "@npm//rxjs", "@npm//url-loader", + "//packages/kbn-i18n-react", + "//packages/kbn-i18n", + "//packages/kbn-shared-ux-services", + "//packages/kbn-shared-ux-storybook", + "//packages/kbn-shared-ux-utility", + "//packages/shared-ux/avatar/solution", + "//packages/shared-ux/card/no_data", + "//packages/shared-ux/link/redirect_app", + "//packages/shared-ux/page/solution_nav", + "//packages/shared-ux/prompt/no_data_views", ] # In this array place dependencies necessary to build the types, which will include the @@ -69,25 +70,26 @@ RUNTIME_DEPS = [ # # References to NPM packages work the same as RUNTIME_DEPS TYPES_DEPS = [ + "@npm//@elastic/eui", + "@npm//@emotion/css", + "@npm//@emotion/react", + "@npm//@types/classnames", + "@npm//@types/jest", + "@npm//@types/node", + "@npm//@types/react", + "@npm//react-use", + "@npm//rxjs", "//packages/kbn-ambient-ui-types", "//packages/kbn-i18n-react:npm_module_types", "//packages/kbn-i18n:npm_module_types", - "//packages/shared-ux/avatar/solution:npm_module_types", - "//packages/shared-ux/link/redirect_app:npm_module_types", - "//packages/shared-ux/prompt/no_data_views:npm_module_types", - "//packages/shared-ux/card/no_data:npm_module_types", "//packages/kbn-shared-ux-services:npm_module_types", "//packages/kbn-shared-ux-storybook:npm_module_types", "//packages/kbn-shared-ux-utility:npm_module_types", - "@npm//@types/node", - "@npm//@types/jest", - "@npm//@types/react", - "@npm//@types/classnames", - "@npm//@emotion/react", - "@npm//@emotion/css", - "@npm//@elastic/eui", - "@npm//react-use", - "@npm//rxjs", + "//packages/shared-ux/avatar/solution:npm_module_types", + "//packages/shared-ux/card/no_data:npm_module_types", + "//packages/shared-ux/link/redirect_app:npm_module_types", + "//packages/shared-ux/page/solution_nav:npm_module_types", + "//packages/shared-ux/prompt/no_data_views:npm_module_types", ] jsts_transpiler( diff --git a/packages/kbn-shared-ux-components/src/index.ts b/packages/kbn-shared-ux-components/src/index.ts index 970e584d95782..9e11d9341fe59 100644 --- a/packages/kbn-shared-ux-components/src/index.ts +++ b/packages/kbn-shared-ux-components/src/index.ts @@ -6,8 +6,6 @@ * Side Public License, v 1. */ -export { KibanaPageTemplateSolutionNav } from './page_template/solution_nav'; - // TODO: clintandrewhall - NoDataPageProps is a temporary addition until it is split into its own package export type { KibanaPageTemplateProps, NoDataPageProps } from './page_template'; diff --git a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_config_page/no_data_config_page.tsx b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_config_page/no_data_config_page.tsx index 77c2d659b56ef..c21431a8107fe 100644 --- a/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_config_page/no_data_config_page.tsx +++ b/packages/kbn-shared-ux-components/src/page_template/no_data_page/no_data_config_page/no_data_config_page.tsx @@ -5,10 +5,12 @@ * in compliance with, at your election, the Elastic License 2.0 or the Server * Side Public License, v 1. */ -import { EuiPageTemplate } from '@elastic/eui'; + import React from 'react'; +import { EuiPageTemplate } from '@elastic/eui'; +import { withSolutionNav } from '@kbn/shared-ux-page-solution-nav'; + import { NoDataPage } from '../no_data_page'; -import { withSolutionNav } from '../../with_solution_nav'; import { KibanaPageTemplateProps } from '../../types'; import { getClasses, NO_DATA_PAGE_TEMPLATE_PROPS } from '../../util'; diff --git a/packages/kbn-shared-ux-components/src/page_template/page_template.stories.tsx b/packages/kbn-shared-ux-components/src/page_template/page_template.stories.tsx index 6e0cf9fdb2e52..ae6be1297f018 100644 --- a/packages/kbn-shared-ux-components/src/page_template/page_template.stories.tsx +++ b/packages/kbn-shared-ux-components/src/page_template/page_template.stories.tsx @@ -8,9 +8,10 @@ import React from 'react'; import { EuiButton, EuiText } from '@elastic/eui'; +import { SolutionNavProps } from '@kbn/shared-ux-page-solution-nav'; + import { KibanaPageTemplate } from './page_template'; import mdx from './page_template.mdx'; -import { KibanaPageTemplateSolutionNavProps } from './solution_nav'; import { KibanaPageTemplateProps } from './types'; export default { @@ -36,7 +37,7 @@ const noDataConfig = { docsLink: 'http://wwww.docs.elastic.co', }; -const items: KibanaPageTemplateSolutionNavProps['items'] = [ +const items: SolutionNavProps['items'] = [ { name: 'Ingest', id: '1', diff --git a/packages/kbn-shared-ux-components/src/page_template/page_template.test.tsx b/packages/kbn-shared-ux-components/src/page_template/page_template.test.tsx index 8d073e14f7776..1324b60b92870 100644 --- a/packages/kbn-shared-ux-components/src/page_template/page_template.test.tsx +++ b/packages/kbn-shared-ux-components/src/page_template/page_template.test.tsx @@ -8,11 +8,12 @@ import React from 'react'; import { shallow, render } from 'enzyme'; +import { SolutionNavProps } from '@kbn/shared-ux-page-solution-nav'; + import { KibanaPageTemplate } from './page_template'; -import { KibanaPageTemplateSolutionNavProps } from './solution_nav'; import { NoDataPageProps } from './no_data_page'; -const items: KibanaPageTemplateSolutionNavProps['items'] = [ +const items: SolutionNavProps['items'] = [ { name: 'Ingest', id: '1', diff --git a/packages/kbn-shared-ux-components/src/page_template/page_template.tsx b/packages/kbn-shared-ux-components/src/page_template/page_template.tsx index 6d63d54e9b9dd..467f02224b0de 100644 --- a/packages/kbn-shared-ux-components/src/page_template/page_template.tsx +++ b/packages/kbn-shared-ux-components/src/page_template/page_template.tsx @@ -6,8 +6,6 @@ * Side Public License, v 1. */ -import './page_template.scss'; - import React, { FunctionComponent } from 'react'; import { NoDataConfigPage, NoDataConfigPageWithSolutionNavBar } from './no_data_page'; diff --git a/packages/kbn-shared-ux-components/src/page_template/page_template_inner.tsx b/packages/kbn-shared-ux-components/src/page_template/page_template_inner.tsx index cef22f2713efc..46424348f2ff3 100644 --- a/packages/kbn-shared-ux-components/src/page_template/page_template_inner.tsx +++ b/packages/kbn-shared-ux-components/src/page_template/page_template_inner.tsx @@ -9,8 +9,8 @@ import React, { FunctionComponent } from 'react'; import { EuiEmptyPrompt, EuiPageTemplate } from '@elastic/eui'; +import { withSolutionNav } from '@kbn/shared-ux-page-solution-nav'; -import { withSolutionNav } from './with_solution_nav'; import { KibanaPageTemplateProps } from './types'; import { getClasses } from './util'; diff --git a/packages/kbn-shared-ux-components/src/page_template/types.ts b/packages/kbn-shared-ux-components/src/page_template/types.ts index cd4764a976db8..6a8b0d583ed18 100644 --- a/packages/kbn-shared-ux-components/src/page_template/types.ts +++ b/packages/kbn-shared-ux-components/src/page_template/types.ts @@ -7,7 +7,8 @@ */ import { EuiPageTemplateProps } from '@elastic/eui'; -import { KibanaPageTemplateSolutionNavProps } from './solution_nav'; +import { SolutionNavProps } from '@kbn/shared-ux-page-solution-nav'; + import { NoDataPageProps } from './no_data_page'; export type KibanaPageTemplateProps = EuiPageTemplateProps & { @@ -21,7 +22,7 @@ export type KibanaPageTemplateProps = EuiPageTemplateProps & { /** * Quick creation of EuiSideNav. Hooks up mobile instance too */ - solutionNav?: KibanaPageTemplateSolutionNavProps; + solutionNav?: SolutionNavProps; /** * Accepts a configuration object, that when provided, ignores pageHeader and children and instead * displays Agent, Beats, and custom cards to direct users to the right ingest location diff --git a/packages/kbn-test/jest_integration_node/jest-preset.js b/packages/kbn-test/jest_integration_node/jest-preset.js index 50f097f0386d3..8f5f433139ab7 100644 --- a/packages/kbn-test/jest_integration_node/jest-preset.js +++ b/packages/kbn-test/jest_integration_node/jest-preset.js @@ -43,4 +43,8 @@ module.exports = { testEnvironment: 'node', snapshotSerializers: [], setupFiles: ['/node_modules/@kbn/test/target_node/jest/setup/babel_polyfill.js'], + haste: { + ...preset.haste, + throwOnModuleCollision: true, + }, }; diff --git a/packages/kbn-test/jest_node/jest-preset.js b/packages/kbn-test/jest_node/jest-preset.js index 9a0e9a16321e4..78d20414b9389 100644 --- a/packages/kbn-test/jest_node/jest-preset.js +++ b/packages/kbn-test/jest_node/jest-preset.js @@ -13,4 +13,8 @@ module.exports = { testEnvironment: 'node', snapshotSerializers: [], setupFiles: ['/node_modules/@kbn/test/target_node/jest/setup/babel_polyfill.js'], + haste: { + ...preset.haste, + throwOnModuleCollision: true, + }, }; diff --git a/packages/shared-ux/button/exit_full_screen/src/__snapshots__/exit_full_screen_button.test.tsx.snap b/packages/shared-ux/button/exit_full_screen/src/__snapshots__/exit_full_screen_button.test.tsx.snap index 793c17ae1b1e3..b16ba80b305ee 100644 --- a/packages/shared-ux/button/exit_full_screen/src/__snapshots__/exit_full_screen_button.test.tsx.snap +++ b/packages/shared-ux/button/exit_full_screen/src/__snapshots__/exit_full_screen_button.test.tsx.snap @@ -46,9 +46,92 @@ exports[` with kibana services is rendered 1`] = `

- In full screen mode, press ESC to exit. + + + , + ], + }, + } + } + isStringTag={true} + serialized={ + Object { + "map": undefined, + "name": "4rqdyn-euiScreenReaderOnly", + "next": undefined, + "styles": "; + // Take the element out of the layout + position: absolute; + // Keep it vertically inline + top: auto; + // Chrome requires a left value, and Selenium (used by Kibana's FTR) requires an off-screen position for its .getVisibleText() to not register SR-only text + left: -10000px; + // The element must have a size (for some screen readers) + width: 1px; + height: 1px; + // But reduce the visible size to nothing + clip: rect(0 0 0 0); + clip-path: inset(50%); + // And ensure no overflows occur + overflow: hidden; + // Chrome requires the negative margin to not cause overflows of parent containers + margin: -1px; +;label:euiScreenReaderOnly;;;;", + "toString": [Function], + } + } + /> +

+ In full screen mode, press ESC to exit. +