string | |
+| [type](./kibana-plugin-core-public.savedobjectsbulkresolveobject.type.md) | string | |
+
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveobject.type.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveobject.type.md
new file mode 100644
index 0000000000000..09c7991012da8
--- /dev/null
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveobject.type.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkResolveObject](./kibana-plugin-core-public.savedobjectsbulkresolveobject.md) > [type](./kibana-plugin-core-public.savedobjectsbulkresolveobject.type.md)
+
+## SavedObjectsBulkResolveObject.type property
+
+Signature:
+
+```typescript
+type: string;
+```
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveresponse.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveresponse.md
new file mode 100644
index 0000000000000..36a92d02b8aaa
--- /dev/null
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveresponse.md
@@ -0,0 +1,19 @@
+
+
+[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkResolveResponse](./kibana-plugin-core-public.savedobjectsbulkresolveresponse.md)
+
+## SavedObjectsBulkResolveResponse interface
+
+
+Signature:
+
+```typescript
+export interface SavedObjectsBulkResolveResponseArray<SavedObjectsResolveResponse<T>> | |
+
diff --git a/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveresponse.resolved_objects.md b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveresponse.resolved_objects.md
new file mode 100644
index 0000000000000..3597a771efe08
--- /dev/null
+++ b/docs/development/core/public/kibana-plugin-core-public.savedobjectsbulkresolveresponse.resolved_objects.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [SavedObjectsBulkResolveResponse](./kibana-plugin-core-public.savedobjectsbulkresolveresponse.md) > [resolved\_objects](./kibana-plugin-core-public.savedobjectsbulkresolveresponse.resolved_objects.md)
+
+## SavedObjectsBulkResolveResponse.resolved\_objects property
+
+Signature:
+
+```typescript
+resolved_objects: Array(objects?: SavedObjectsBulkCreateObject[], options?: SavedObjectsBulkCreateOptions) => Promise<SavedObjectsBatchResponse<unknown>> | Creates multiple documents at once |
| [bulkGet](./kibana-plugin-core-public.savedobjectsclient.bulkget.md) | | (objects?: Array<{ id: string; type: string; }>) => Promise<SavedObjectsBatchResponse<unknown>> | Returns an array of objects by id |
+| [bulkResolve](./kibana-plugin-core-public.savedobjectsclient.bulkresolve.md) | | <T = unknown>(objects?: Array<{ id: string; type: string; }>) => Promise<{ resolved_objects: ResolvedSimpleSavedObject<T>[]; }> | Resolves an array of objects by id, using any legacy URL aliases if they exist |
| [create](./kibana-plugin-core-public.savedobjectsclient.create.md) | | <T = unknown>(type: string, attributes: T, options?: SavedObjectsCreateOptions) => Promise<SimpleSavedObject<T>> | Persists an object |
| [delete](./kibana-plugin-core-public.savedobjectsclient.delete.md) | | (type: string, id: string, options?: SavedObjectsDeleteOptions | undefined) => ReturnType<SavedObjectsApi['delete']> | Deletes an object |
| [find](./kibana-plugin-core-public.savedobjectsclient.find.md) | | <T = unknown, A = unknown>(options: SavedObjectsFindOptions) => Promise<SavedObjectsFindResponsePublic<T, unknown>> | Search for objects |
diff --git a/docs/development/core/server/kibana-plugin-core-server.deprecationsservicesetup.md b/docs/development/core/server/kibana-plugin-core-server.deprecationsservicesetup.md
index 7b2cbdecd146a..2bc7f6cba594d 100644
--- a/docs/development/core/server/kibana-plugin-core-server.deprecationsservicesetup.md
+++ b/docs/development/core/server/kibana-plugin-core-server.deprecationsservicesetup.md
@@ -27,6 +27,7 @@ async function getDeprecations({ esClient, savedObjectsClient }: GetDeprecations
const deprecations: DeprecationsDetails[] = [];
const count = await getFooCount(savedObjectsClient);
if (count > 0) {
+ // Example of a manual correctiveAction
deprecations.push({
title: i18n.translate('xpack.foo.deprecations.title', {
defaultMessage: `Foo's are deprecated`
diff --git a/docs/development/core/server/kibana-plugin-core-server.md b/docs/development/core/server/kibana-plugin-core-server.md
index 66c0299669dc4..89203cb94d573 100644
--- a/docs/development/core/server/kibana-plugin-core-server.md
+++ b/docs/development/core/server/kibana-plugin-core-server.md
@@ -146,6 +146,8 @@ The plugin integrates with the core system via lifecycle events: `setup`
| [SavedObjectsBaseOptions](./kibana-plugin-core-server.savedobjectsbaseoptions.md) | |
| [SavedObjectsBulkCreateObject](./kibana-plugin-core-server.savedobjectsbulkcreateobject.md) | |
| [SavedObjectsBulkGetObject](./kibana-plugin-core-server.savedobjectsbulkgetobject.md) | |
+| [SavedObjectsBulkResolveObject](./kibana-plugin-core-server.savedobjectsbulkresolveobject.md) | |
+| [SavedObjectsBulkResolveResponse](./kibana-plugin-core-server.savedobjectsbulkresolveresponse.md) | |
| [SavedObjectsBulkResponse](./kibana-plugin-core-server.savedobjectsbulkresponse.md) | |
| [SavedObjectsBulkUpdateObject](./kibana-plugin-core-server.savedobjectsbulkupdateobject.md) | |
| [SavedObjectsBulkUpdateOptions](./kibana-plugin-core-server.savedobjectsbulkupdateoptions.md) | |
diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveobject.id.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveobject.id.md
new file mode 100644
index 0000000000000..135848191cff7
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveobject.id.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkResolveObject](./kibana-plugin-core-server.savedobjectsbulkresolveobject.md) > [id](./kibana-plugin-core-server.savedobjectsbulkresolveobject.id.md)
+
+## SavedObjectsBulkResolveObject.id property
+
+Signature:
+
+```typescript
+id: string;
+```
diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveobject.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveobject.md
new file mode 100644
index 0000000000000..3960511b21434
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveobject.md
@@ -0,0 +1,20 @@
+
+
+[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkResolveObject](./kibana-plugin-core-server.savedobjectsbulkresolveobject.md)
+
+## SavedObjectsBulkResolveObject interface
+
+
+Signature:
+
+```typescript
+export interface SavedObjectsBulkResolveObject
+```
+
+## Properties
+
+| Property | Type | Description |
+| --- | --- | --- |
+| [id](./kibana-plugin-core-server.savedobjectsbulkresolveobject.id.md) | string | |
+| [type](./kibana-plugin-core-server.savedobjectsbulkresolveobject.type.md) | string | |
+
diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveobject.type.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveobject.type.md
new file mode 100644
index 0000000000000..790edde7fe079
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveobject.type.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkResolveObject](./kibana-plugin-core-server.savedobjectsbulkresolveobject.md) > [type](./kibana-plugin-core-server.savedobjectsbulkresolveobject.type.md)
+
+## SavedObjectsBulkResolveObject.type property
+
+Signature:
+
+```typescript
+type: string;
+```
diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveresponse.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveresponse.md
new file mode 100644
index 0000000000000..8384ecc1861f4
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveresponse.md
@@ -0,0 +1,19 @@
+
+
+[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkResolveResponse](./kibana-plugin-core-server.savedobjectsbulkresolveresponse.md)
+
+## SavedObjectsBulkResolveResponse interface
+
+
+Signature:
+
+```typescript
+export interface SavedObjectsBulkResolveResponseArray<SavedObjectsResolveResponse<T>> | |
+
diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveresponse.resolved_objects.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveresponse.resolved_objects.md
new file mode 100644
index 0000000000000..4d11b146fd848
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkresolveresponse.resolved_objects.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsBulkResolveResponse](./kibana-plugin-core-server.savedobjectsbulkresolveresponse.md) > [resolved\_objects](./kibana-plugin-core-server.savedobjectsbulkresolveresponse.resolved_objects.md)
+
+## SavedObjectsBulkResolveResponse.resolved\_objects property
+
+Signature:
+
+```typescript
+resolved_objects: ArraySavedObjectsBulkResolveObject[] | an array of objects containing id, type |
+| options | SavedObjectsBaseOptions | |
+
+Returns:
+
+`PromiseSavedObjectsBulkResolveObject[] | |
+| options | SavedObjectsBaseOptions | |
+
+Returns:
+
+`PromiseopenPointInTimeForType.Only use this API if you have an advanced use case that's not solved by the [SavedObjectsRepository.createPointInTimeFinder()](./kibana-plugin-core-server.savedobjectsrepository.createpointintimefinder.md) method. |
diff --git a/docs/getting-started/images/add-sample-data.png b/docs/getting-started/images/add-sample-data.png
deleted file mode 100644
index 07a536b19d7d0..0000000000000
Binary files a/docs/getting-started/images/add-sample-data.png and /dev/null differ
diff --git a/docs/getting-started/images/addData_sampleDataCards_7.15.0.png b/docs/getting-started/images/addData_sampleDataCards_7.15.0.png
new file mode 100644
index 0000000000000..27e10b98b9670
Binary files /dev/null and b/docs/getting-started/images/addData_sampleDataCards_7.15.0.png differ
diff --git a/docs/getting-started/images/dashboard_ecommerceRevenueDashboard_7.15.0.png b/docs/getting-started/images/dashboard_ecommerceRevenueDashboard_7.15.0.png
new file mode 100644
index 0000000000000..5b62832b1d093
Binary files /dev/null and b/docs/getting-started/images/dashboard_ecommerceRevenueDashboard_7.15.0.png differ
diff --git a/docs/getting-started/images/dashboard_sampleDataAddFilter_7.15.0.png b/docs/getting-started/images/dashboard_sampleDataAddFilter_7.15.0.png
new file mode 100644
index 0000000000000..804fd83de57be
Binary files /dev/null and b/docs/getting-started/images/dashboard_sampleDataAddFilter_7.15.0.png differ
diff --git a/docs/getting-started/images/dashboard_sampleDataFilter_7.15.0.png b/docs/getting-started/images/dashboard_sampleDataFilter_7.15.0.png
new file mode 100644
index 0000000000000..f1f46ab42371a
Binary files /dev/null and b/docs/getting-started/images/dashboard_sampleDataFilter_7.15.0.png differ
diff --git a/docs/getting-started/images/tutorial-sample-dashboard.png b/docs/getting-started/images/tutorial-sample-dashboard.png
deleted file mode 100644
index 5e06009d0824e..0000000000000
Binary files a/docs/getting-started/images/tutorial-sample-dashboard.png and /dev/null differ
diff --git a/docs/getting-started/images/tutorial-sample-filter.png b/docs/getting-started/images/tutorial-sample-filter.png
deleted file mode 100644
index 8823da311ebb5..0000000000000
Binary files a/docs/getting-started/images/tutorial-sample-filter.png and /dev/null differ
diff --git a/docs/getting-started/quick-start-guide.asciidoc b/docs/getting-started/quick-start-guide.asciidoc
index ed249008ac8de..d614aece5b425 100644
--- a/docs/getting-started/quick-start-guide.asciidoc
+++ b/docs/getting-started/quick-start-guide.asciidoc
@@ -31,7 +31,7 @@ Sample data sets come with sample visualizations, dashboards, and more to help y
. On the *Sample eCommerce orders* card, click *Add data*.
+
[role="screenshot"]
-image::images/add-sample-data.png[Add data UI for the sample data sets]
+image::images/addData_sampleDataCards_7.15.0.png[Add data UI for the sample data sets]
[float]
[[explore-the-data]]
@@ -70,7 +70,7 @@ A dashboard is a collection of panels that you can use to view and analyze the d
. Click *[eCommerce] Revenue Dashboard*.
+
[role="screenshot"]
-image::getting-started/images/tutorial-sample-dashboard.png[The [eCommerce] Revenue Dashboard that comes with the Sample eCommerce order data set]
+image::images/dashboard_ecommerceRevenueDashboard_7.15.0.png[The [eCommerce] Revenue Dashboard that comes with the Sample eCommerce order data set]
[float]
[[create-a-visualization]]
@@ -78,14 +78,16 @@ image::getting-started/images/tutorial-sample-dashboard.png[The [eCommerce] Reve
Create a treemap panel that shows the top sales regions and manufacturers, then add the panel to the dashboard.
-. From the toolbar, click *Edit*, then click *Create visualzation*.
+. In the toolbar, click *Edit*.
-. Open the *Chart type* menu, then select *Treemap*.
+. On the dashboard, click *Create visualization*.
+
+. In the drag-and-drop visualization editor, open the *Visualization type* dropdown, then select *Treemap*.
+
[role="screenshot"]
image::getting-started/images/tutorial-visualization-dropdown.png[Chart type menu with Treemap selected]
-. From the *Available fields* list, drag and drop the following fields onto the workspace:
+. From the *Available fields* list, drag the following fields to the workspace:
* *geoip.city_name*
@@ -97,9 +99,6 @@ image::getting-started/images/tutorial-visualization-treemap.png[Treemap that di
. Click *Save and return*.
+
The treemap appears as the last visualization panel on the dashboard.
-+
-[role="screenshot"]
-image::getting-started/images/tutorial-final-dashboard.gif[Final dashboard with new treemap visualization]
[float]
[[interact-with-the-data]]
@@ -114,7 +113,7 @@ You can interact with the dashboard data using controls that allow you to apply
. Click *Apply changes*.
+
[role="screenshot"]
-image::getting-started/images/tutorial-sample-filter.png[The [eCommerce] Revenue Dashboard that shows only the women's clothing data from the Gnomehouse manufacturer]
+image::images/dashboard_sampleDataFilter_7.15.0.png[The [eCommerce] Revenue Dashboard that shows only the women's clothing data from the Gnomehouse manufacturer]
[float]
[[filter-and-query-the-data]]
@@ -133,7 +132,7 @@ To view a subset of the data, you can apply filters to the dashboard panels. App
. Click *Save*.
+
[role="screenshot"]
-image::getting-started/images/tutorial-sample-filter2.png[The [eCommerce] Revenue Dashboard that shows only the women's clothing data generated on Wednesday from the Gnomehouse manufacturer]
+image::images/dashboard_sampleDataAddFilter_7.15.0.png[The [eCommerce] Revenue Dashboard that shows only the women's clothing data generated on Wednesday from the Gnomehouse manufacturer]
[float]
[[quick-start-whats-next]]
diff --git a/docs/maps/images/timeslider_toggle_icon.png b/docs/maps/images/timeslider_toggle_icon.png
new file mode 100644
index 0000000000000..00b09215782ec
Binary files /dev/null and b/docs/maps/images/timeslider_toggle_icon.png differ
diff --git a/docs/maps/index.asciidoc b/docs/maps/index.asciidoc
index cbc00e965e566..157eb0f044666 100644
--- a/docs/maps/index.asciidoc
+++ b/docs/maps/index.asciidoc
@@ -68,7 +68,7 @@ Customize each layer to highlight meaningful dimensions in your data. For exampl
[float]
=== Focus on only the data that’s important to you
-Search across the layers in your map to focus in on just the data you want. Combine free text search with field-based search using the <implements LocatorPublic
{ return url; } + public getRedirectUrl(params: P, options: FormatSearchParamsOptions = {}): string { + const { baseUrl = '', version = '0.0.0' } = this.deps; + const redirectOptions: RedirectOptions = { + id: this.definition.id, + version, + params, + }; + const formatOptions: FormatSearchParamsOptions = { + ...options, + lzCompress: options.lzCompress ?? true, + }; + const search = formatSearchParams(redirectOptions, formatOptions).toString(); + + return baseUrl + '/app/r?' + search; + } + public async navigate( params: P, { replace = false }: LocatorNavigationParams = {} diff --git a/src/plugins/share/public/url_service/redirect/util/format_search_params.test.ts b/src/plugins/share/common/url_service/locators/redirect/format_search_params.test.ts similarity index 66% rename from src/plugins/share/public/url_service/redirect/util/format_search_params.test.ts rename to src/plugins/share/common/url_service/locators/redirect/format_search_params.test.ts index f8d8d6a6295d9..63c2b88e8cf2e 100644 --- a/src/plugins/share/public/url_service/redirect/util/format_search_params.test.ts +++ b/src/plugins/share/common/url_service/locators/redirect/format_search_params.test.ts @@ -6,6 +6,7 @@ * Side Public License, v 1. */ +import { decompressFromBase64 } from 'lz-string'; import { formatSearchParams } from './format_search_params'; import { parseSearchParams } from './parse_search_params'; @@ -41,3 +42,23 @@ test('can format and then parse redirect options', () => { expect(parsed).toEqual(options); }); + +test('compresses params using lz-string when { lzCompress: true } provided', () => { + const options = { + id: 'LOCATOR_ID', + version: '7.21.3', + params: { + dashboardId: '123', + mode: 'edit', + }, + }; + const formatted = formatSearchParams(options, { lzCompress: true }); + const search = new URLSearchParams(formatted); + const paramsJson = decompressFromBase64(search.get('lz')!)!; + + expect(JSON.parse(paramsJson)).toEqual(options.params); + + const parsed = parseSearchParams(formatted.toString()); + + expect(parsed).toEqual(options); +}); diff --git a/src/plugins/share/common/url_service/locators/redirect/format_search_params.ts b/src/plugins/share/common/url_service/locators/redirect/format_search_params.ts new file mode 100644 index 0000000000000..8bcacdd9a7a80 --- /dev/null +++ b/src/plugins/share/common/url_service/locators/redirect/format_search_params.ts @@ -0,0 +1,35 @@ +/* + * 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 { compressToBase64 } from 'lz-string'; +import { RedirectOptions } from './types'; + +export interface FormatSearchParamsOptions { + lzCompress?: boolean; +} + +export function formatSearchParams( + opts: RedirectOptions, + { lzCompress }: FormatSearchParamsOptions = {} +): URLSearchParams { + const searchParams = new URLSearchParams(); + + searchParams.set('l', opts.id); + searchParams.set('v', opts.version); + + const json = JSON.stringify(opts.params); + + if (lzCompress) { + const compressed = compressToBase64(json); + searchParams.set('lz', compressed); + } else { + searchParams.set('p', JSON.stringify(opts.params)); + } + + return searchParams; +} diff --git a/tasks/config/peg.js b/src/plugins/share/common/url_service/locators/redirect/index.ts similarity index 77% rename from tasks/config/peg.js rename to src/plugins/share/common/url_service/locators/redirect/index.ts index 906767d6db285..cf9c0ae1b4f98 100644 --- a/tasks/config/peg.js +++ b/src/plugins/share/common/url_service/locators/redirect/index.ts @@ -6,4 +6,6 @@ * Side Public License, v 1. */ -module.exports = {}; +export * from './types'; +export * from './format_search_params'; +export * from './parse_search_params'; diff --git a/src/plugins/share/public/url_service/redirect/util/parse_search_params.test.ts b/src/plugins/share/common/url_service/locators/redirect/parse_search_params.test.ts similarity index 100% rename from src/plugins/share/public/url_service/redirect/util/parse_search_params.test.ts rename to src/plugins/share/common/url_service/locators/redirect/parse_search_params.test.ts diff --git a/src/plugins/share/public/url_service/redirect/util/parse_search_params.ts b/src/plugins/share/common/url_service/locators/redirect/parse_search_params.ts similarity index 92% rename from src/plugins/share/public/url_service/redirect/util/parse_search_params.ts rename to src/plugins/share/common/url_service/locators/redirect/parse_search_params.ts index 7745e6dad43b1..a4711c30db5d0 100644 --- a/src/plugins/share/public/url_service/redirect/util/parse_search_params.ts +++ b/src/plugins/share/common/url_service/locators/redirect/parse_search_params.ts @@ -8,7 +8,8 @@ import type { SerializableRecord } from '@kbn/utility-types'; import { i18n } from '@kbn/i18n'; -import type { RedirectOptions } from '../redirect_manager'; +import { decompressFromBase64 } from 'lz-string'; +import type { RedirectOptions } from './types'; /** * Parses redirect endpoint URL path search parameters. Expects them in the @@ -23,9 +24,11 @@ import type { RedirectOptions } from '../redirect_manager'; */ export function parseSearchParams(urlSearch: string): RedirectOptions { const search = new URLSearchParams(urlSearch); + const id = search.get('l'); const version = search.get('v'); - const paramsJson = search.get('p'); + const compressed = search.get('lz'); + const paramsJson: string | null = compressed ? decompressFromBase64(compressed) : search.get('p'); if (!id) { const message = i18n.translate( diff --git a/src/plugins/share/common/url_service/locators/redirect/types.ts b/src/plugins/share/common/url_service/locators/redirect/types.ts new file mode 100644 index 0000000000000..67ce994b26614 --- /dev/null +++ b/src/plugins/share/common/url_service/locators/redirect/types.ts @@ -0,0 +1,28 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 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 { SerializableRecord } from '@kbn/utility-types'; + +/** + * @public + * Serializable locator parameters that can be used by the redirect service to navigate to a + * location in Kibana. + * + * When passed to the public `share` plugin `.navigate()` function, locator params will also + * be migrated. + */ +export interface RedirectOptions
{ + /** Locator ID. */ + id: string; + + /** Kibana version when locator params were generated. */ + version: string; + + /** Locator params. */ + params: P; +} diff --git a/src/plugins/share/common/url_service/locators/types.ts b/src/plugins/share/common/url_service/locators/types.ts index ba9c6c9185d23..107188b405047 100644 --- a/src/plugins/share/common/url_service/locators/types.ts +++ b/src/plugins/share/common/url_service/locators/types.ts @@ -9,6 +9,7 @@ import type { SerializableRecord } from '@kbn/utility-types'; import { DependencyList } from 'react'; import { PersistableState } from 'src/plugins/kibana_utils/common'; +import type { FormatSearchParamsOptions } from './redirect'; /** * URL locator registry. @@ -62,11 +63,24 @@ export interface LocatorPublic
extends Persistable
/**
* Returns a URL as a string.
*
+ * @deprecated Use `getRedirectUrl` instead. `getRedirectUrl` will preserve
+ * the location state, whereas the `getUrl` just return the URL without
+ * the location state.
+ *
* @param params URL locator parameters.
* @param getUrlParams URL construction parameters.
*/
getUrl(params: P, getUrlParams?: LocatorGetUrlParams): Promise {
- /** Locator ID. */
- id: string;
-
- /** Kibana version when locator params where generated. */
- version: string;
-
- /** Locator params. */
- params: P;
-}
+import { parseSearchParams, RedirectOptions } from '../../../common/url_service/locators/redirect';
export interface RedirectManagerDependencies {
url: UrlService;
@@ -48,7 +27,8 @@ export class RedirectManager {
id: 'r',
title: 'Redirect endpoint',
chromeless: true,
- mount: (params) => {
+ mount: async (params) => {
+ const { render } = await import('./render');
const unmount = render(params.element, { manager: this });
this.onMount(params.history.location.search);
return () => {
diff --git a/src/plugins/share/public/url_service/redirect/util/format_search_params.ts b/src/plugins/share/public/url_service/redirect/util/format_search_params.ts
deleted file mode 100644
index 12c6424182a87..0000000000000
--- a/src/plugins/share/public/url_service/redirect/util/format_search_params.ts
+++ /dev/null
@@ -1,19 +0,0 @@
-/*
- * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
- * or more contributor license agreements. Licensed under the Elastic License
- * 2.0 and the Server Side Public License, v 1; you may not use this file except
- * in compliance with, at your election, the Elastic License 2.0 or the Server
- * Side Public License, v 1.
- */
-
-import { RedirectOptions } from '../redirect_manager';
-
-export function formatSearchParams(opts: RedirectOptions): URLSearchParams {
- const searchParams = new URLSearchParams();
-
- searchParams.set('l', opts.id);
- searchParams.set('v', opts.version);
- searchParams.set('p', JSON.stringify(opts.params));
-
- return searchParams;
-}
diff --git a/src/plugins/share/server/plugin.ts b/src/plugins/share/server/plugin.ts
index 76e10372cdb67..18bb72ae24869 100644
--- a/src/plugins/share/server/plugin.ts
+++ b/src/plugins/share/server/plugin.ts
@@ -31,8 +31,10 @@ export class SharePlugin implements Plugin