Skip to content

Commit f6c03ae

Browse files
authored
UI settings move to NP (#47590) (#48395)
* add tests for logWithMetadata in LP * allow passing metadata to log in NP & LP * move ui_settings_client to NP * add ui_settings config * add ui_settings_service * switch to NP logging * export types * bootstrap uiSettings service in NP * pass NP uiSettings to LP * move ui_settings mock to NP * add test for mixin and switch to NP logger * make UiSettingsClient.getDefaults sync as it is * ui_settings_client uses private fields * ui_settings_client uses private methods * keep uiSettings config validation in NP only * update mocks * core context should know it is mocked * add tests for ui_settings_service * remove unused code from ui_settings_mixin test * improve types in ui_settings_mixin test * gen docs * test moved to NP * set pkg version in tests explicitly * update mocks in tests * UiSettingsServiceSetup --> InternalUiSettingsServiceSetup * add links to types * address eli comment * regen docs * remove unused types
1 parent 05c76f2 commit f6c03ae

File tree

64 files changed

+968
-302
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+968
-302
lines changed

.eslintrc.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,9 @@ module.exports = {
150150
'!src/core/server/index.ts',
151151
'!src/core/server/mocks.ts',
152152
'!src/core/server/types.ts',
153+
// for absolute imports until fixed in
154+
// https://github.com/elastic/kibana/issues/36096
155+
'!src/core/server/types',
153156
'!src/core/server/*.test.mocks.ts',
154157

155158
'src/plugins/**/public/**/*',
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [IUiSettingsClient](./kibana-plugin-server.iuisettingsclient.md) &gt; [get](./kibana-plugin-server.iuisettingsclient.get.md)
4+
5+
## IUiSettingsClient.get property
6+
7+
Retrieves uiSettings values set by the user with fallbacks to default values if not specified.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
get: <T extends SavedObjectAttribute = any>(key: string) => Promise<T>;
13+
```
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [IUiSettingsClient](./kibana-plugin-server.iuisettingsclient.md) &gt; [getAll](./kibana-plugin-server.iuisettingsclient.getall.md)
4+
5+
## IUiSettingsClient.getAll property
6+
7+
Retrieves a set of all uiSettings values set by the user with fallbacks to default values if not specified.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
getAll: <T extends SavedObjectAttribute = any>() => Promise<Record<string, T>>;
13+
```
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [IUiSettingsClient](./kibana-plugin-server.iuisettingsclient.md) &gt; [getDefaults](./kibana-plugin-server.iuisettingsclient.getdefaults.md)
4+
5+
## IUiSettingsClient.getDefaults property
6+
7+
Returns uiSettings default values [UiSettingsParams](./kibana-plugin-server.uisettingsparams.md)
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
getDefaults: () => Record<string, UiSettingsParams>;
13+
```
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [IUiSettingsClient](./kibana-plugin-server.iuisettingsclient.md) &gt; [getUserProvided](./kibana-plugin-server.iuisettingsclient.getuserprovided.md)
4+
5+
## IUiSettingsClient.getUserProvided property
6+
7+
Retrieves a set of all uiSettings values set by the user.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
getUserProvided: <T extends SavedObjectAttribute = any>() => Promise<Record<string, {
13+
userValue?: T;
14+
isOverridden?: boolean;
15+
}>>;
16+
```
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [IUiSettingsClient](./kibana-plugin-server.iuisettingsclient.md) &gt; [isOverridden](./kibana-plugin-server.iuisettingsclient.isoverridden.md)
4+
5+
## IUiSettingsClient.isOverridden property
6+
7+
Shows whether the uiSettings value set by the user.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
isOverridden: (key: string) => boolean;
13+
```
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [IUiSettingsClient](./kibana-plugin-server.iuisettingsclient.md)
4+
5+
## IUiSettingsClient interface
6+
7+
Service that provides access to the UiSettings stored in elasticsearch.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
export interface IUiSettingsClient
13+
```
14+
15+
## Properties
16+
17+
| Property | Type | Description |
18+
| --- | --- | --- |
19+
| [get](./kibana-plugin-server.iuisettingsclient.get.md) | <code>&lt;T extends SavedObjectAttribute = any&gt;(key: string) =&gt; Promise&lt;T&gt;</code> | Retrieves uiSettings values set by the user with fallbacks to default values if not specified. |
20+
| [getAll](./kibana-plugin-server.iuisettingsclient.getall.md) | <code>&lt;T extends SavedObjectAttribute = any&gt;() =&gt; Promise&lt;Record&lt;string, T&gt;&gt;</code> | Retrieves a set of all uiSettings values set by the user with fallbacks to default values if not specified. |
21+
| [getDefaults](./kibana-plugin-server.iuisettingsclient.getdefaults.md) | <code>() =&gt; Record&lt;string, UiSettingsParams&gt;</code> | Returns uiSettings default values [UiSettingsParams](./kibana-plugin-server.uisettingsparams.md) |
22+
| [getUserProvided](./kibana-plugin-server.iuisettingsclient.getuserprovided.md) | <code>&lt;T extends SavedObjectAttribute = any&gt;() =&gt; Promise&lt;Record&lt;string, {</code><br/><code> userValue?: T;</code><br/><code> isOverridden?: boolean;</code><br/><code> }&gt;&gt;</code> | Retrieves a set of all uiSettings values set by the user. |
23+
| [isOverridden](./kibana-plugin-server.iuisettingsclient.isoverridden.md) | <code>(key: string) =&gt; boolean</code> | Shows whether the uiSettings value set by the user. |
24+
| [remove](./kibana-plugin-server.iuisettingsclient.remove.md) | <code>(key: string) =&gt; Promise&lt;void&gt;</code> | Removes uiSettings value by key. |
25+
| [removeMany](./kibana-plugin-server.iuisettingsclient.removemany.md) | <code>(keys: string[]) =&gt; Promise&lt;void&gt;</code> | Removes multiple uiSettings values by keys. |
26+
| [set](./kibana-plugin-server.iuisettingsclient.set.md) | <code>&lt;T extends SavedObjectAttribute = any&gt;(key: string, value: T) =&gt; Promise&lt;void&gt;</code> | Writes uiSettings value and marks it as set by the user. |
27+
| [setMany](./kibana-plugin-server.iuisettingsclient.setmany.md) | <code>&lt;T extends SavedObjectAttribute = any&gt;(changes: Record&lt;string, T&gt;) =&gt; Promise&lt;void&gt;</code> | Writes multiple uiSettings values and marks them as set by the user. |
28+
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [IUiSettingsClient](./kibana-plugin-server.iuisettingsclient.md) &gt; [remove](./kibana-plugin-server.iuisettingsclient.remove.md)
4+
5+
## IUiSettingsClient.remove property
6+
7+
Removes uiSettings value by key.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
remove: (key: string) => Promise<void>;
13+
```
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [IUiSettingsClient](./kibana-plugin-server.iuisettingsclient.md) &gt; [removeMany](./kibana-plugin-server.iuisettingsclient.removemany.md)
4+
5+
## IUiSettingsClient.removeMany property
6+
7+
Removes multiple uiSettings values by keys.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
removeMany: (keys: string[]) => Promise<void>;
13+
```
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [IUiSettingsClient](./kibana-plugin-server.iuisettingsclient.md) &gt; [set](./kibana-plugin-server.iuisettingsclient.set.md)
4+
5+
## IUiSettingsClient.set property
6+
7+
Writes uiSettings value and marks it as set by the user.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
set: <T extends SavedObjectAttribute = any>(key: string, value: T) => Promise<void>;
13+
```

0 commit comments

Comments
 (0)