[Data views] Implement persistable state

packages/kbn-es-query/src/es_query/index.ts

@@ -16,7 +16,9 @@ export type {
   IFieldSubType,
   BoolQuery,
   DataViewBase,
+  DataViewBaseSerializable,
   DataViewFieldBase,
+  DataViewFieldBaseSerializable,
   IFieldSubTypeMulti,
   IFieldSubTypeNested,
 } from './types';

packages/kbn-es-query/src/es_query/types.ts

@@ -7,22 +7,23 @@
  */
 
 import * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey';
+import { SerializableRecord } from '@kbn/utility-types';
 
 /**
  * A field's sub type
  * @public
  */
 export type IFieldSubType = IFieldSubTypeMultiOptional | IFieldSubTypeNestedOptional;
 
-export interface IFieldSubTypeMultiOptional {
+export interface IFieldSubTypeMultiOptional extends SerializableRecord {
   multi?: { parent: string };
 }
 
 export interface IFieldSubTypeMulti {
   multi: { parent: string };
 }
 
-export interface IFieldSubTypeNestedOptional {
+export interface IFieldSubTypeNestedOptional extends SerializableRecord {
   nested?: { path: string };
 }
 
@@ -53,6 +54,8 @@ export interface DataViewFieldBase {
   scripted?: boolean;
 }
 
+export type DataViewFieldBaseSerializable = SerializableRecord & DataViewFieldBase;
+
 /**
  * A base interface for an index pattern
  * @public
@@ -63,6 +66,8 @@ export interface DataViewBase {
   title: string;
 }
 
+export type DataViewBaseSerializable = SerializableRecord & DataViewBase;
+
 export interface BoolQuery {
   must: estypes.QueryDslQueryContainer[];
   must_not: estypes.QueryDslQueryContainer[];

packages/kbn-es-query/src/index.ts

@@ -9,7 +9,9 @@
 export type {
   BoolQuery,
   DataViewBase,
+  DataViewBaseSerializable,
   DataViewFieldBase,
+  DataViewFieldBaseSerializable,
   EsQueryConfig,
   IFieldSubType,
   IFieldSubTypeMulti,

src/plugins/data_views/common/data_views/persistable_state.test.ts

@@ -0,0 +1,40 @@
+/*
+ * 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 { DataViewBaseSerializable } from '@kbn/es-query';
+import { DataViewPersistableStateService } from './persistable_state';
+import { SavedObjectReference } from '@kbn/core/types';
+const { inject, extract } = DataViewPersistableStateService;
+
+describe('data view persistable state tests', () => {
+  test('inject references', () => {
+    const state: DataViewBaseSerializable = {
+      id: 'my-id',
+      title: 'my-title',
+      fields: [],
+    };
+    const references: SavedObjectReference[] = [];
+
+    const result = inject(state, references);
+
+    expect(result).toBe(state);
+  });
+
+  test('extract references', () => {
+    const state: DataViewBaseSerializable = {
+      id: 'my-id',
+      title: 'my-title',
+      fields: [],
+    };
+
+    const result = extract(state);
+
+    expect(result.state).toBe(state);
+    expect(result.references).toEqual([]);
+  });
+});

src/plugins/data_views/common/data_views/persistable_state.ts

@@ -0,0 +1,22 @@
+/*
+ * 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 { DataViewBaseSerializable } from '@kbn/es-query';
+import { PersistableStateService } from '@kbn/kibana-utils-plugin/common';
+
+export const DataViewPersistableStateService: PersistableStateService<DataViewBaseSerializable> = {
+  inject: (state, references) => {
+    return state;
+  },
+  extract: (state) => {
+    return { state, references: [] };
+  },
+  getAllMigrations: () => ({}),
+  migrateToLatest: ({ state }) => state,
+  telemetry: () => ({}),
+};

src/plugins/data_views/common/fields/persistable_state.test.ts

@@ -0,0 +1,38 @@
+/*
+ * 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 { DataViewFieldBaseSerializable } from '@kbn/es-query';
+import { DataViewFieldPersistableStateService } from './persistable_state';
+import { SavedObjectReference } from '@kbn/core/types';
+const { inject, extract } = DataViewFieldPersistableStateService;
+
+describe('data view field persistable state tests', () => {
+  test('inject references', () => {
+    const state: DataViewFieldBaseSerializable = {
+      name: 'my-name',
+      type: 'my-type',
+    };
+    const references: SavedObjectReference[] = [];
+
+    const result = inject(state, references);
+
+    expect(result).toBe(state);
+  });
+
+  test('extract references', () => {
+    const state: DataViewFieldBaseSerializable = {
+      name: 'my-name',
+      type: 'my-type',
+    };
+
+    const result = extract(state);
+
+    expect(result.state).toBe(state);
+    expect(result.references).toEqual([]);
+  });
+});

src/plugins/data_views/common/fields/persistable_state.ts

@@ -0,0 +1,23 @@
+/*
+ * 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 { DataViewFieldBaseSerializable } from '@kbn/es-query';
+import { PersistableStateService } from '@kbn/kibana-utils-plugin/common';
+
+export const DataViewFieldPersistableStateService: PersistableStateService<DataViewFieldBaseSerializable> =
+  {
+    inject: (state, references) => {
+      return state;
+    },
+    extract: (state) => {
+      return { state, references: [] };
+    },
+    getAllMigrations: () => ({}),
+    migrateToLatest: ({ state }) => state,
+    telemetry: () => ({}),
+  };

src/plugins/kibana_utils/common/persistable_state/types.ts

@@ -159,7 +159,7 @@ export interface PersistableStateService<P extends Serializable = Serializable>
    * @param version Current semver version of the `state`.
    * @returns A serializable state object migrated to the latest state.
    */
-  migrateToLatest?: (state: VersionedState) => P;
+  migrateToLatest?: (state: VersionedState<P>) => P;
 
   /**
    * returns all registered migrations