[Controls] Add ESQL control types to options list

src/platform/packages/shared/kbn-alerts-ui-shared/src/alert_filter_controls/constants.ts

@@ -8,7 +8,7 @@
  */
 
 import { ALERT_RULE_NAME, ALERT_STATUS } from '@kbn/rule-data-utils';
-import type { OptionsListControlState } from '@kbn/controls-plugin/public';
+import type { OptionsListDSLControlState } from '@kbn/controls-plugin/public';
 import { i18n } from '@kbn/i18n';
 import type { FilterControlConfig } from './types';
 
@@ -65,7 +65,7 @@ export const TEST_IDS = {
   },
 };
 
-export const COMMON_OPTIONS_LIST_CONTROL_INPUTS: Partial<OptionsListControlState> = {
+export const COMMON_OPTIONS_LIST_CONTROL_INPUTS: Partial<OptionsListDSLControlState> = {
   hideExclude: true,
   hideSort: true,
   placeholder: '',

src/platform/packages/shared/kbn-alerts-ui-shared/src/alert_filter_controls/mocks/data.ts

@@ -9,7 +9,7 @@
 
 import type {
   ControlGroupRuntimeState,
-  OptionsListControlState,
+  OptionsListDSLControlState,
 } from '@kbn/controls-plugin/public';
 import type { Filter } from '@kbn/es-query';
 import { ALERT_DURATION, ALERT_RULE_NAME, ALERT_START, ALERT_STATUS } from '@kbn/rule-data-utils';
@@ -41,7 +41,7 @@ export const sampleOutputData: ControlGroupOutput = {
   ],
 };
 
-export const initialInputData: ControlGroupRuntimeState<OptionsListControlState> = {
+export const initialInputData: ControlGroupRuntimeState<OptionsListDSLControlState> = {
   initialChildControlState: {
     '0': {
       type: 'optionsListControl',

src/platform/packages/shared/kbn-alerts-ui-shared/src/alert_filter_controls/types.ts

@@ -10,7 +10,7 @@
 import type { Filter, Query, TimeRange } from '@kbn/es-query';
 import type {
   ControlGroupRenderer,
-  OptionsListControlState,
+  OptionsListDSLControlState,
   ControlGroupRuntimeState,
   ControlGroupRendererApi,
 } from '@kbn/controls-plugin/public';
@@ -19,7 +19,7 @@ import type { Storage } from '@kbn/kibana-utils-plugin/public';
 export type FilterUrlFormat = Record<
   string,
   Pick<
-    OptionsListControlState,
+    OptionsListDSLControlState,
     'selectedOptions' | 'title' | 'fieldName' | 'existsSelected' | 'exclude'
   >
 >;
@@ -29,7 +29,7 @@ export interface FilterContextType {
   addControl: (controls: FilterControlConfig) => void;
 }
 
-export type FilterControlConfig = Omit<OptionsListControlState, 'dataViewId'> & {
+export type FilterControlConfig = Omit<OptionsListDSLControlState, 'dataViewId'> & {
   /*
    * Determines the presence and order of a control
    * */

src/platform/packages/shared/kbn-alerts-ui-shared/src/alert_filter_controls/utils.ts

@@ -9,7 +9,7 @@
 
 import type {
   ControlGroupRuntimeState,
-  OptionsListControlState,
+  OptionsListDSLControlState,
   ControlPanelState,
 } from '@kbn/controls-plugin/public';
 
@@ -25,7 +25,7 @@ export const getFilterItemObjListFromControlState = (controlState: ControlGroupR
   const panels = getPanelsInOrderFromControlsState(controlState);
   return panels.map((panel) => {
     const { fieldName, selectedOptions, title, existsSelected, exclude, hideActionBar } =
-      panel as ControlPanelState<OptionsListControlState>;
+      panel as ControlPanelState<OptionsListDSLControlState>;
 
     return {
       fieldName: fieldName as string,

src/platform/plugins/shared/controls/common/options_list/index.ts

@@ -13,6 +13,8 @@ export type { OptionsListSearchTechnique } from './suggestions_searching';
 export type { OptionsListSortingType } from './suggestions_sorting';
 export type {
   OptionsListControlState,
+  OptionsListESQLControlState,
+  OptionsListDSLControlState,
   OptionsListDisplaySettings,
   OptionsListFailureResponse,
   OptionsListRequest,

src/platform/plugins/shared/controls/common/options_list/types.ts

@@ -10,6 +10,7 @@
 import type { DataView, FieldSpec, RuntimeFieldSpec } from '@kbn/data-views-plugin/common';
 import type { AggregateQuery, BoolQuery, Filter, Query, TimeRange } from '@kbn/es-query';
 
+import type { ESQLControlState } from '@kbn/esql-types';
 import type { OptionsListSelection } from './options_list_selections';
 import type { OptionsListSortingType } from './suggestions_sorting';
 import type { DefaultDataControlState } from '../types';
@@ -29,17 +30,27 @@ export interface OptionsListDisplaySettings {
   hideSort?: boolean;
 }
 
-export interface OptionsListControlState
-  extends DefaultDataControlState,
-    OptionsListDisplaySettings {
+type OptionsListBaseControlState = OptionsListDisplaySettings & {
   searchTechnique?: OptionsListSearchTechnique;
   sort?: OptionsListSortingType;
   selectedOptions?: OptionsListSelection[];
   existsSelected?: boolean;
   runPastTimeout?: boolean;
   singleSelect?: boolean;
   exclude?: boolean;
-}
+};
+export type OptionsListDSLControlState = DefaultDataControlState & OptionsListBaseControlState;
+export type OptionsListESQLControlState = ESQLControlState & OptionsListBaseControlState;
+
+export type OptionsListControlState = OptionsListDSLControlState | OptionsListESQLControlState;
+
+export const isOptionsListESQLControlState = (
+  state: OptionsListControlState | undefined
+): state is OptionsListESQLControlState =>
+  typeof state !== 'undefined' &&
+  Object.hasOwn(state, 'esqlQuery') &&
+  Object.hasOwn(state, 'controlType') &&
+  !Object.hasOwn(state, 'fieldName');
 
 /**
  * ----------------------------------------------------------------
@@ -92,7 +103,7 @@ export type OptionsListRequest = Omit<
  */
 export interface OptionsListRequestBody
   extends Pick<
-    OptionsListControlState,
+    OptionsListDSLControlState,
     'fieldName' | 'searchTechnique' | 'sort' | 'selectedOptions'
   > {
   runtimeFieldMap?: Record<string, RuntimeFieldSpec>;

src/platform/plugins/shared/controls/public/controls/data_controls/options_list_control/components/options_list_editor_options.tsx

@@ -87,8 +87,8 @@ export const OptionsListEditorOptions = ({
   );
 
   const compatibleSearchTechniques = useMemo(
-    () => getCompatibleSearchTechniques(field.type),
-    [field.type]
+    () => getCompatibleSearchTechniques(field?.type),
+    [field?.type]
   );
 
   const searchOptions = useMemo(() => {

src/platform/plugins/shared/controls/public/controls/data_controls/options_list_control/get_options_list_control_factory.tsx

@@ -26,6 +26,7 @@ import type { PublishingSubject } from '@kbn/presentation-publishing';
 
 import { initializeUnsavedChanges } from '@kbn/presentation-containers';
 import { OPTIONS_LIST_CONTROL } from '@kbn/controls-constants';
+import { isOptionsListESQLControlState } from '../../../../common/options_list/types';
 import type {
   OptionsListControlState,
   OptionsListSortingType,
@@ -71,6 +72,10 @@ export const getOptionsListControlFactory = (): DataControlFactory<
     },
     CustomOptionsComponent: OptionsListEditorOptions,
     buildControl: async ({ initialState, finalizeApi, uuid, controlGroupApi }) => {
+      if (isOptionsListESQLControlState(initialState)) {
+        throw new Error('ES|QL control state handling not yet implemented');
+      }
+
       /** Serializable state - i.e. the state that is saved with the control */
       const editorStateManager = initializeEditorStateManager(initialState);
 
@@ -297,6 +302,9 @@ export const getOptionsListControlFactory = (): DataControlFactory<
           existsSelected: false,
         },
         onReset: (lastSaved) => {
+          if (isOptionsListESQLControlState(lastSaved?.rawState)) {
+            throw new Error('ES|QL control state handling not yet implemented');
+          }
           dataControlManager.reinitializeState(lastSaved?.rawState);
           selectionsManager.reinitializeState(lastSaved?.rawState);
           editorStateManager.reinitializeState(lastSaved?.rawState);

src/platform/plugins/shared/controls/public/controls/data_controls/options_list_control/types.ts

@@ -12,8 +12,6 @@ import type { Subject } from 'rxjs';
 import type { PublishesTitle, PublishingSubject } from '@kbn/presentation-publishing';
 import type { SubjectsOf, SettersOf } from '@kbn/presentation-publishing/state_manager/types';
 import type {
-  OptionsListControlState,
-  OptionsListDisplaySettings,
   OptionsListSelection,
   OptionsListSortingType,
   OptionsListSuggestions,
@@ -28,32 +26,33 @@ export type OptionsListControlApi = DataControlApi & {
   setSelectedOptions: (options: OptionsListSelection[] | undefined) => void;
 };
 
-export interface OptionsListComponentState
-  extends Omit<OptionsListControlState, keyof OptionsListDisplaySettings> {
-  searchString: string;
-  searchStringValid: boolean;
-  requestSize: number;
-}
-
 interface PublishesOptions {
   availableOptions$: PublishingSubject<OptionsListSuggestions | undefined>;
   invalidSelections$: PublishingSubject<Set<OptionsListSelection>>;
   totalCardinality$: PublishingSubject<number>;
 }
-export type OptionsListState = Pick<DefaultDataControlState, 'fieldName'> &
+
+/**
+ * A type consisting of only the properties that the options list control puts into state managers
+ * and then passes to the UI component. Excludes any managed state properties that don't end up being used
+ * by the component
+ */
+export type OptionsListComponentState = Pick<DefaultDataControlState, 'fieldName'> &
   SelectionsState &
   EditorState &
-  TemporaryState & { sort: OptionsListSortingType | undefined };
+  TemporaryState & {
+    sort: OptionsListSortingType | undefined;
+  };
 
-type PublishesOptionsListState = SubjectsOf<OptionsListState>;
-type OptionsListStateSetters = Partial<SettersOf<OptionsListState>> &
-  SettersOf<Pick<OptionsListState, 'sort' | 'searchString' | 'requestSize' | 'exclude'>>;
+type PublishesOptionsListComponentState = SubjectsOf<OptionsListComponentState>;
+type OptionsListComponentStateSetters = Partial<SettersOf<OptionsListComponentState>> &
+  SettersOf<Pick<OptionsListComponentState, 'sort' | 'searchString' | 'requestSize' | 'exclude'>>;
 
 export type OptionsListComponentApi = PublishesField &
   PublishesOptions &
-  PublishesOptionsListState &
+  PublishesOptionsListComponentState &
   Pick<PublishesTitle, 'title$'> &
-  OptionsListStateSetters & {
+  OptionsListComponentStateSetters & {
     deselectOption: (key: string | undefined) => void;
     makeSelection: (key: string | undefined, showOnlySelected: boolean) => void;
     loadMoreSubject: Subject<void>;

src/platform/plugins/shared/controls/public/controls/data_controls/types.ts

@@ -16,7 +16,7 @@ import type {
   PublishingSubject,
 } from '@kbn/presentation-publishing';
 
-import type { DefaultDataControlState } from '../../../common';
+import type { DefaultControlState } from '../../../common';
 import type { ControlGroupApi } from '../../control_group/types';
 import type { ControlFactory, DefaultControlApi } from '../types';
 import type { PublishesAsyncFilters } from './publishes_async_filters';
@@ -36,17 +36,17 @@ export type DataControlApi = DefaultControlApi &
   PublishesAsyncFilters;
 
 export interface CustomOptionsComponentProps<
-  State extends DefaultDataControlState = DefaultDataControlState
+  State extends DefaultControlState = DefaultControlState
 > {
   initialState: Partial<State>;
-  field: DataViewField;
+  field?: DataViewField;
   updateState: (newState: Partial<State>) => void;
   setControlEditorValid: (valid: boolean) => void;
   controlGroupApi: ControlGroupApi;
 }
 
 export interface DataControlFactory<
-  State extends DefaultDataControlState = DefaultDataControlState,
+  State extends DefaultControlState = DefaultControlState,
   Api extends DataControlApi = DataControlApi
 > extends ControlFactory<State, Api> {
   isFieldCompatible: (field: DataViewField) => boolean;

src/platform/plugins/shared/controls/public/controls/esql_control/types.ts

@@ -13,28 +13,28 @@ import type {
   PublishesTitle,
 } from '@kbn/presentation-publishing';
 import type { DefaultControlApi } from '../types';
-import type { OptionsListState } from '../data_controls/options_list_control/types';
+import type { OptionsListComponentState } from '../data_controls/options_list_control/types';
 
 export type ESQLControlApi = DefaultControlApi &
   PublishesESQLVariable &
   HasEditCapabilities &
   Pick<Required<PublishesTitle>, 'defaultTitle$'> &
   PublishesDataLoading;
 
-type HideExcludeUnusedState = Pick<OptionsListState, 'exclude'>;
-type HideExistsUnusedState = Pick<OptionsListState, 'existsSelected'>;
-type HideSortUnusedState = Pick<OptionsListState, 'sort'>;
+type HideExcludeUnusedState = Pick<OptionsListComponentState, 'exclude'>;
+type HideExistsUnusedState = Pick<OptionsListComponentState, 'existsSelected'>;
+type HideSortUnusedState = Pick<OptionsListComponentState, 'sort'>;
 type DisableLoadSuggestionsUnusedState = Pick<
-  OptionsListState,
+  OptionsListComponentState,
   'dataLoading' | 'requestSize' | 'runPastTimeout'
 >;
-type DisableMultiSelectUnusedState = Pick<OptionsListState, 'singleSelect'>;
-type DisableInvalidSelectionsUnusedState = Pick<OptionsListState, 'invalidSelections'>;
+type DisableMultiSelectUnusedState = Pick<OptionsListComponentState, 'singleSelect'>;
+type DisableInvalidSelectionsUnusedState = Pick<OptionsListComponentState, 'invalidSelections'>;
 
 export type OptionsListESQLUnusedState = HideExcludeUnusedState &
   HideExistsUnusedState &
   HideSortUnusedState &
   DisableLoadSuggestionsUnusedState &
   DisableMultiSelectUnusedState &
   DisableInvalidSelectionsUnusedState &
-  Pick<OptionsListState, 'fieldName'>;
+  Pick<OptionsListComponentState, 'fieldName'>;

src/platform/plugins/shared/controls/public/index.ts

@@ -41,7 +41,7 @@ export type {
   ControlPanelsState,
   DefaultDataControlState,
 } from '../common';
-export type { OptionsListControlState } from '../common/options_list';
+export type { OptionsListControlState, OptionsListDSLControlState } from '../common/options_list';
 
 export { serializeRuntimeState } from './control_group/utils/serialize_runtime_state';