[Dashboards as code] Convert anomaly single metric view Embeddable types to API schemas (elastic#239161)

## Summary

Convert SingleMetricViewerEmbeddableState to API schemas

---------

Co-authored-by: kibanamachine <[email protected]>

Author: angorayc

x-pack/platform/packages/shared/ml/anomaly_utils/schemas.ts

@@ -30,9 +30,11 @@ export const criteriaFieldSchema = schema.object({
   fieldType: schema.maybe(mlEntityFieldTypeSchema),
 });
 
+export const mlEntityFieldValueSchema = schema.oneOf([schema.string(), schema.number()]);
+
 export const mlEntityFieldSchema = schema.object({
   fieldName: schema.string(),
-  fieldValue: schema.maybe(schema.oneOf([schema.string(), schema.number()])),
+  fieldValue: schema.maybe(mlEntityFieldValueSchema),
   fieldType: schema.maybe(mlEntityFieldTypeSchema),
   operation: schema.maybe(mlEntityFieldOperationSchema),
   cardinality: schema.maybe(schema.number()),

x-pack/platform/plugins/shared/ml/public/embeddables/single_metric_viewer/single_metric_viewer_controls_initializer.ts

@@ -11,7 +11,7 @@ import type { JobId } from '../../../common/types/anomaly_detection_jobs';
 import type {
   SingleMetricViewerEmbeddableState,
   SingleMetricViewerEmbeddableUserInput,
-} from '../types';
+} from './types';
 
 export type AnomalySwimLaneControlsState = Pick<
   SingleMetricViewerEmbeddableState,

x-pack/platform/plugins/shared/ml/public/embeddables/single_metric_viewer/single_metric_viewer_embeddable_factory.tsx

@@ -24,7 +24,7 @@ import { BehaviorSubject, Subscription, merge } from 'rxjs';
 import { initializeUnsavedChanges } from '@kbn/presentation-containers';
 import { ANOMALY_SINGLE_METRIC_VIEWER_EMBEDDABLE_TYPE } from '..';
 import type { MlPluginStart, MlStartDependencies } from '../../plugin';
-import type { SingleMetricViewerEmbeddableApi, SingleMetricViewerEmbeddableState } from '../types';
+import type { SingleMetricViewerEmbeddableApi } from '../types';
 import {
   initializeSingleMetricViewerControls,
   singleMetricViewerComparators,
@@ -34,6 +34,7 @@ import { getServices } from './get_services';
 import { useReactEmbeddableExecutionContext } from '../common/use_embeddable_execution_context';
 import { getSingleMetricViewerComponent } from '../../shared_components/single_metric_viewer';
 import { EmbeddableSingleMetricViewerUserInput } from './single_metric_viewer_setup_flyout';
+import type { SingleMetricViewerEmbeddableState } from './types';
 
 export const getSingleMetricViewerEmbeddableFactory = (
   getStartServices: StartServicesAccessor<MlStartDependencies, MlPluginStart>

x-pack/platform/plugins/shared/ml/public/embeddables/single_metric_viewer/single_metric_viewer_initializer.tsx

@@ -28,7 +28,6 @@ import { extractErrorMessage } from '@kbn/ml-error-utils';
 import type { MlJob } from '@elastic/elasticsearch/lib/api/types';
 import type { TimeRangeBounds } from '@kbn/ml-time-buckets';
 import type { MlApi } from '../../application/services/ml_api_service';
-import type { SingleMetricViewerEmbeddableInput } from '..';
 import { ML_PAGES } from '../../../common/constants/locator';
 import { SeriesControls } from '../../application/timeseriesexplorer/components/series_controls';
 import {
@@ -39,6 +38,7 @@ import { useMlLink } from '../../application/contexts/kibana';
 import { JobSelectorControl } from '../../alerting/job_selector';
 import type { SingleMetricViewerEmbeddableUserInput, MlEntity } from '..';
 import { getDefaultSingleMetricViewerPanelTitle } from './get_default_panel_title';
+import type { SingleMetricViewerEmbeddableInput } from './types';
 
 export interface SingleMetricViewerInitializerProps {
   bounds: TimeRangeBounds;

x-pack/platform/plugins/shared/ml/public/embeddables/single_metric_viewer/single_metric_viewer_setup_flyout.tsx

@@ -12,10 +12,11 @@ import type { DataPublicPluginStart } from '@kbn/data-plugin/public';
 import type { SharePluginStart } from '@kbn/share-plugin/public';
 import { StorageContextProvider } from '@kbn/ml-local-storage';
 import { Storage } from '@kbn/kibana-utils-plugin/public';
-import type { SingleMetricViewerEmbeddableUserInput, SingleMetricViewerEmbeddableInput } from '..';
+import type { SingleMetricViewerEmbeddableUserInput } from '..';
 import { SingleMetricViewerInitializer } from './single_metric_viewer_initializer';
 import type { MlApi } from '../../application/services/ml_api_service';
 import { ML_STORAGE_KEYS } from '../../../common/types/storage';
+import type { SingleMetricViewerEmbeddableInput } from './types';
 
 export function EmbeddableSingleMetricViewerUserInput({
   coreStart,

x-pack/platform/plugins/shared/ml/public/embeddables/single_metric_viewer/types.ts

@@ -0,0 +1,33 @@
+/*
+ * 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; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import type { MlEntityField } from '@kbn/ml-anomaly-utils';
+import type { TypeOf } from '@kbn/config-schema';
+import type {
+  singleMetricViewerEmbeddableCustomInputSchema,
+  singleMetricViewerEmbeddableInputSchema,
+  singleMetricViewerEmbeddableStateSchema,
+  singleMetricViewerEmbeddableUserInputSchema,
+} from '../../../server/embeddable/single_metric_viewer/single_metric_viewer';
+
+export type MlEntity = Record<string, MlEntityField['fieldValue']>;
+
+export type SingleMetricViewerEmbeddableUserInput = TypeOf<
+  typeof singleMetricViewerEmbeddableUserInputSchema
+>;
+
+export type SingleMetricViewerEmbeddableCustomInput = TypeOf<
+  typeof singleMetricViewerEmbeddableCustomInputSchema
+>;
+
+export type SingleMetricViewerEmbeddableState = TypeOf<
+  typeof singleMetricViewerEmbeddableStateSchema
+>;
+
+export type SingleMetricViewerEmbeddableInput = TypeOf<
+  typeof singleMetricViewerEmbeddableInputSchema
+>;

x-pack/platform/plugins/shared/ml/public/embeddables/types.ts

@@ -6,7 +6,6 @@
  */
 
 import type { CoreStart } from '@kbn/core/public';
-import type { RefreshInterval } from '@kbn/data-plugin/common';
 import type { DefaultEmbeddableApi } from '@kbn/embeddable-plugin/public';
 import type { Filter, Query, TimeRange } from '@kbn/es-query';
 import type { MlEntityField } from '@kbn/ml-anomaly-utils';
@@ -20,7 +19,6 @@ import type {
   PublishesTimeRange,
   PublishesWritableTitle,
   PublishesDataViews,
-  SerializedTitles,
 } from '@kbn/presentation-publishing';
 import { type BehaviorSubject } from 'rxjs';
 import type { TypeOf } from '@kbn/config-schema';
@@ -53,21 +51,30 @@ import type {
   anomalySwimlaneEmbeddableUserInputSchema,
   anomalySwimlaneInitialInputSchema,
 } from '../../server/embeddable/schemas';
+import type {
+  MlEntity,
+  SingleMetricViewerEmbeddableState,
+  SingleMetricViewerEmbeddableUserInput,
+} from './single_metric_viewer/types';
 
 export type {
   AnomalySwimLaneEmbeddableState,
   AnomalySwimLaneEmbeddableApi,
 } from './anomaly_swimlane/types';
 
+export type {
+  MlEntity,
+  SingleMetricViewerEmbeddableUserInput,
+  SingleMetricViewerEmbeddableState,
+} from './single_metric_viewer/types';
+
 /**
  * Common API for all ML embeddables
  */
 export interface MlEmbeddableBaseApi<StateType extends object = object>
   extends DefaultEmbeddableApi<StateType>,
     PublishesTimeRange {}
 
-export type MlEntity = Record<string, MlEntityField['fieldValue']>;
-
 /** Manual input by the user */
 export type AnomalySwimlaneEmbeddableUserInput = TypeOf<
   typeof anomalySwimlaneEmbeddableUserInputSchema
@@ -168,36 +175,9 @@ export interface AnomalyChartsAttachmentApi extends AnomalyChartsApi {
   };
 }
 
-/** Manual input by the user */
-export interface SingleMetricViewerEmbeddableUserInput {
-  forecastId?: string;
-  functionDescription?: string;
-  jobIds: JobId[];
-  selectedDetectorIndex: number;
-  selectedEntities?: MlEntity;
-  panelTitle?: string;
-}
-
-export interface SingleMetricViewerEmbeddableCustomInput
-  extends Omit<SingleMetricViewerEmbeddableUserInput, 'panelTitle'> {
-  id?: string;
-  filters?: Filter[];
-  query?: Query;
-  refreshConfig?: RefreshInterval;
-  timeRange: TimeRange | undefined;
-}
-
-export type SingleMetricViewerEmbeddableInput = SingleMetricViewerEmbeddableCustomInput & {
-  title?: string;
-};
-
 /**
  * Persisted state for the Single Metric Embeddable.
  */
-export interface SingleMetricViewerEmbeddableState
-  extends SerializedTitles,
-    SingleMetricViewerEmbeddableCustomInput {}
-
 export type SingleMetricViewerEmbeddableApi =
   MlEmbeddableBaseApi<SingleMetricViewerEmbeddableState> &
     PublishesWritableTitle &

x-pack/platform/plugins/shared/ml/server/embeddable/schemas.ts

@@ -7,3 +7,4 @@
 
 export * from './anomaly_charts/anomaly_charts';
 export * from './anomaly_swimlane/anomaly_swimlane';
+export * from './single_metric_viewer/single_metric_viewer';

x-pack/platform/plugins/shared/ml/server/embeddable/single_metric_viewer/single_metric_viewer.ts

@@ -0,0 +1,46 @@
+/*
+ * 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; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { schema } from '@kbn/config-schema';
+import { filterSchema, querySchema, timeRangeSchema } from '@kbn/es-query-server';
+import { refreshIntervalSchema } from '@kbn/data-service-server';
+import { serializedTitlesSchema } from '@kbn/presentation-publishing-schemas';
+import { mlEntityFieldValueSchema } from '@kbn/ml-anomaly-utils/schemas';
+
+const baseUserInputProps = schema.object({
+  forecastId: schema.maybe(schema.string()),
+  functionDescription: schema.maybe(schema.string()),
+  jobIds: schema.arrayOf(schema.string()),
+  selectedDetectorIndex: schema.number(),
+  selectedEntities: schema.maybe(
+    schema.recordOf(schema.string(), schema.maybe(mlEntityFieldValueSchema))
+  ),
+});
+
+export const singleMetricViewerEmbeddableUserInputSchema = schema.object({
+  ...baseUserInputProps.getPropSchemas(),
+  panelTitle: schema.maybe(schema.string()),
+});
+
+export const singleMetricViewerEmbeddableCustomInputSchema = schema.object({
+  ...baseUserInputProps.getPropSchemas(),
+  id: schema.maybe(schema.string()),
+  filters: schema.maybe(schema.arrayOf(filterSchema)),
+  query: schema.maybe(querySchema),
+  refreshConfig: schema.maybe(refreshIntervalSchema),
+  timeRange: schema.maybe(timeRangeSchema),
+});
+
+export const singleMetricViewerEmbeddableInputSchema = schema.object({
+  ...singleMetricViewerEmbeddableCustomInputSchema.getPropSchemas(),
+  title: schema.maybe(schema.string()),
+});
+
+export const singleMetricViewerEmbeddableStateSchema = schema.object({
+  ...serializedTitlesSchema.getPropSchemas(),
+  ...singleMetricViewerEmbeddableCustomInputSchema.getPropSchemas(),
+});