make schema required

src/core/public/index.ts

@@ -171,7 +171,7 @@ export {
   ErrorToastOptions,
 } from './notifications';
 
-export { MountPoint, UnmountCallback } from './types';
+export { MountPoint, UnmountCallback, PublicUiSettingsParams } from './types';
 
 /**
  * Core services exposed to the `Plugin` setup lifecycle

src/core/public/types.ts

@@ -19,6 +19,7 @@
 
 export {
   UiSettingsParams,
+  PublicUiSettingsParams,
   UserProvidedValues,
   UiSettingsType,
   ImageValidation,

src/core/public/ui_settings/types.ts

@@ -18,11 +18,11 @@
  */
 
 import { Observable } from 'rxjs';
-import { UiSettingsParams, UserProvidedValues } from 'src/core/server/types';
+import { PublicUiSettingsParams, UserProvidedValues } from 'src/core/server/types';
 
 /** @public */
 export interface UiSettingsState {
-  [key: string]: UiSettingsParams & UserProvidedValues;
+  [key: string]: PublicUiSettingsParams & UserProvidedValues;
 }
 
 /**
@@ -53,7 +53,7 @@ export interface IUiSettingsClient {
    * Gets the metadata about all uiSettings, including the type, default value, and user value
    * for each key.
    */
-  getAll: () => Readonly<Record<string, UiSettingsParams & UserProvidedValues>>;
+  getAll: () => Readonly<Record<string, PublicUiSettingsParams & UserProvidedValues>>;
 
   /**
    * Sets the value for a uiSetting. If the setting is not registered by any plugin

src/core/public/ui_settings/ui_settings_client.ts

@@ -21,14 +21,14 @@ import { cloneDeep, defaultsDeep } from 'lodash';
 import { Observable, Subject, concat, defer, of } from 'rxjs';
 import { filter, map } from 'rxjs/operators';
 
-import { UiSettingsParams, UserProvidedValues } from 'src/core/server/types';
+import { UserProvidedValues, PublicUiSettingsParams } from 'src/core/server/types';
 import { IUiSettingsClient, UiSettingsState } from './types';
 
 import { UiSettingsApi } from './ui_settings_api';
 
 interface UiSettingsClientParams {
   api: UiSettingsApi;
-  defaults: Record<string, UiSettingsParams>;
+  defaults: Record<string, PublicUiSettingsParams>;
   initialSettings?: UiSettingsState;
   done$: Observable<unknown>;
 }
@@ -39,8 +39,8 @@ export class UiSettingsClient implements IUiSettingsClient {
   private readonly updateErrors$ = new Subject<Error>();
 
   private readonly api: UiSettingsApi;
-  private readonly defaults: Record<string, UiSettingsParams>;
-  private cache: Record<string, UiSettingsParams & UserProvidedValues>;
+  private readonly defaults: Record<string, PublicUiSettingsParams>;
+  private cache: Record<string, PublicUiSettingsParams & UserProvidedValues>;
 
   constructor(params: UiSettingsClientParams) {
     this.api = params.api;

src/core/server/ui_settings/ui_settings_service.test.ts

@@ -37,6 +37,7 @@ const defaults = {
     value: 'bar',
     category: [],
     description: '',
+    schema: schema.string(),
   },
 };
 

src/core/types/ui_settings.ts

@@ -79,7 +79,7 @@ export interface UiSettingsParams<T = unknown> {
    * Value validation schema
    * Used to validate value on write and read.
    */
-  schema?: Type<T>;
+  schema: Type<T>;
 }
 
 /**

src/plugins/advanced_settings/public/management_app/advanced_settings.test.tsx

@@ -22,7 +22,11 @@ import { Observable } from 'rxjs';
 import { ReactWrapper } from 'enzyme';
 import { mountWithI18nProvider } from 'test_utils/enzyme_helpers';
 import dedent from 'dedent';
-import { UiSettingsParams, UserProvidedValues, UiSettingsType } from '../../../../core/public';
+import {
+  PublicUiSettingsParams,
+  UserProvidedValues,
+  UiSettingsType,
+} from '../../../../core/public';
 import { FieldSetting } from './types';
 import { AdvancedSettingsComponent } from './advanced_settings';
 import { notificationServiceMock, docLinksServiceMock } from '../../../../core/public/mocks';
@@ -68,7 +72,7 @@ function mockConfig() {
     remove: (key: string) => Promise.resolve(true),
     isCustom: (key: string) => false,
     isOverridden: (key: string) => Boolean(config.getAll()[key].isOverridden),
-    getRegistered: () => ({} as Readonly<Record<string, UiSettingsParams>>),
+    getRegistered: () => ({} as Readonly<Record<string, PublicUiSettingsParams>>),
     overrideLocalDefault: (key: string, value: any) => {},
     getUpdate$: () =>
       new Observable<{
@@ -89,7 +93,7 @@ function mockConfig() {
     getUpdateErrors$: () => new Observable<Error>(),
     get: (key: string, defaultOverride?: any): any => config.getAll()[key] || defaultOverride,
     get$: (key: string) => new Observable<any>(config.get(key)),
-    getAll: (): Readonly<Record<string, UiSettingsParams & UserProvidedValues>> => {
+    getAll: (): Readonly<Record<string, PublicUiSettingsParams & UserProvidedValues>> => {
       return {
         'test:array:setting': {
           ...defaultConfig,

src/plugins/advanced_settings/public/management_app/lib/to_editable_config.test.ts

@@ -17,7 +17,7 @@
  * under the License.
  */
 
-import { UiSettingsParams, StringValidationRegex } from 'src/core/public';
+import { PublicUiSettingsParams, StringValidationRegex } from 'src/core/public';
 import expect from '@kbn/expect';
 import { toEditableConfig } from './to_editable_config';
 
@@ -30,7 +30,7 @@ function invoke({
   name = 'woah',
   value = 'forreal',
 }: {
-  def?: UiSettingsParams & { isOverridden?: boolean };
+  def?: PublicUiSettingsParams & { isOverridden?: boolean };
   name?: string;
   value?: any;
 }) {
@@ -55,7 +55,7 @@ describe('Settings', function() {
       });
 
       describe('when given a setting definition object', function() {
-        let def: UiSettingsParams & { isOverridden?: boolean };
+        let def: PublicUiSettingsParams & { isOverridden?: boolean };
         beforeEach(function() {
           def = {
             value: 'the original',

src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts

@@ -18,7 +18,7 @@
  */
 
 import {
-  UiSettingsParams,
+  PublicUiSettingsParams,
   UserProvidedValues,
   StringValidationRegexString,
   SavedObjectAttribute,
@@ -40,7 +40,7 @@ export function toEditableConfig({
   isCustom,
   isOverridden,
 }: {
-  def: UiSettingsParams & UserProvidedValues<any>;
+  def: PublicUiSettingsParams & UserProvidedValues<any>;
   name: string;
   value: SavedObjectAttribute;
   isCustom: boolean;

test/plugin_functional/plugins/ui_settings_plugin/server/plugin.ts

@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-
+import { schema } from '@kbn/config-schema';
 import { Plugin, CoreSetup } from 'kibana/server';
 
 export class UiSettingsPlugin implements Plugin {
@@ -27,6 +27,7 @@ export class UiSettingsPlugin implements Plugin {
         description: 'just for testing',
         value: '2',
         category: ['any'],
+        schema: schema.string(),
       },
     });