[data views] Implement content management api

src/plugins/data_views/common/content_management/constants.ts

@@ -0,0 +1,14 @@
+/*
+ * 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.
+ */
+
+/**
+ * Data view saved object version.
+ */
+export const LATEST_VERSION = 1;
+
+export const DataViewContentType = 'index-pattern';

src/plugins/data_views/common/content_management/index.ts

@@ -0,0 +1,28 @@
+/*
+ * 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.
+ */
+
+export { LATEST_VERSION } from './constants';
+
+export type {
+  DataViewSavedObject,
+  DataViewGetIn,
+  DataViewGetOut,
+  DataViewCreateIn,
+  DataViewCreateOut,
+  CreateOptions,
+  DataViewUpdateIn,
+  DataViewUpdateOut,
+  UpdateOptions,
+  DataViewDeleteIn,
+  DataViewDeleteOut,
+  DataViewSearchIn,
+  DataViewSearchOut,
+  DataViewSearchQuery,
+} from './types';
+
+export { DataViewContentType } from './constants';

src/plugins/data_views/common/content_management/types.ts

@@ -0,0 +1,115 @@
+/*
+ * 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 type {
+  SavedObject,
+  SavedObjectReference,
+  SavedObjectsResolveResponse,
+  SavedObjectsUpdateResponse,
+} from '@kbn/core-saved-objects-api-server';
+import type { SavedObjectsMigrationVersion } from '@kbn/core-saved-objects-common';
+
+import type {
+  GetIn,
+  CreateIn,
+  SearchIn,
+  UpdateIn,
+  DeleteIn,
+} from '@kbn/content-management-plugin/common';
+
+import { DataViewAttributes } from '../types';
+import { DataViewContentType } from './constants';
+
+interface Reference {
+  type: string;
+  id: string;
+}
+
+export type DataViewSavedObject = SavedObject<DataViewAttributes>;
+
+// ----------- GET --------------
+
+export type DataViewGetIn = GetIn<typeof DataViewContentType>;
+
+export interface DataViewGetOut {
+  savedObject: SavedObjectsResolveResponse<DataViewAttributes>['saved_object'];
+  outcome: SavedObjectsResolveResponse['outcome'];
+  aliasTargetId: SavedObjectsResolveResponse['alias_target_id'];
+  aliasPurpose: SavedObjectsResolveResponse['alias_purpose'];
+}
+
+// ----------- CREATE --------------
+
+export interface CreateOptions {
+  /** If a document with the given `id` already exists, overwrite it's contents (default=false). */
+  overwrite?: boolean;
+  migrationVersion?: SavedObjectsMigrationVersion;
+  /** A semver value that is used when upgrading objects between Kibana versions. */
+  coreMigrationVersion?: string;
+  /** Array of referenced saved objects. */
+  references?: SavedObjectReference[];
+}
+
+export type DataViewCreateIn = CreateIn<
+  typeof DataViewContentType,
+  DataViewAttributes,
+  CreateOptions
+>;
+
+export type DataViewCreateOut = DataViewSavedObject;
+
+// ----------- UPDATE --------------
+
+export interface UpdateOptions {
+  /** Array of referenced saved objects. */
+  references?: SavedObjectReference[];
+}
+
+export type DataViewUpdateIn = UpdateIn<
+  typeof DataViewContentType,
+  DataViewAttributes,
+  UpdateOptions
+>;
+
+export type DataViewUpdateOut = SavedObjectsUpdateResponse<DataViewAttributes>;
+
+// ----------- DELETE --------------
+
+export type DataViewDeleteIn = DeleteIn<typeof DataViewContentType>;
+
+export interface DataViewDeleteOut {
+  status: 'success';
+}
+
+// ----------- SEARCH --------------
+
+export interface MapSearchQuery {
+  search?: string;
+  fields?: string[];
+  searchFields?: string[];
+  perPage?: number;
+  page?: number;
+  defaultSearchOperator?: 'AND' | 'OR';
+  hasReference?: Reference | Reference[];
+  hasNoReference?: Reference | Reference[];
+}
+
+export type MapSearchIn = SearchIn<typeof DataViewContentType, MapSearchQuery>;
+
+export interface MapSearchOut {
+  /** current page in results*/
+  page: number;
+  /** number of results per page */
+  perPage: number;
+  /** total number of results */
+  total: number;
+  /** Array of simple saved objects */
+  savedObjects: DataViewSavedObject[];
+  /** aggregations from the search query */
+  aggregations?: unknown; // TODO: Check if used in Maps
+}

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

@@ -175,7 +175,7 @@ export interface DataViewsServicePublicMethods {
    * Delete data view
    * @param indexPatternId - Id of the data view to delete.
    */
-  delete: (indexPatternId: string) => Promise<{}>;
+  delete: (indexPatternId: string) => Promise<unknown>; // todo
   /**
    * Takes field array and field attributes and returns field map by name.
    * @param fields - Array of fieldspecs
@@ -349,7 +349,7 @@ export class DataViewsService {
    * Refresh cache of index pattern ids and titles.
    */
   private async refreshSavedObjectsCache() {
-    const so = await this.savedObjectsClient.find<DataViewSavedObjectAttrs>({
+    const so = await this.savedObjectsClient.find({
       type: DATA_VIEW_SAVED_OBJECT_TYPE,
       fields: ['title', 'type', 'typeMeta', 'name'],
       perPage: 10000,
@@ -392,7 +392,7 @@ export class DataViewsService {
    * @returns DataView[]
    */
   find = async (search: string, size: number = 10): Promise<DataView[]> => {
-    const savedObjects = await this.savedObjectsClient.find<DataViewSavedObjectAttrs>({
+    const savedObjects = await this.savedObjectsClient.find({
       type: DATA_VIEW_SAVED_OBJECT_TYPE,
       fields: ['title'],
       search,
@@ -726,10 +726,7 @@ export class DataViewsService {
     id: string,
     displayErrors: boolean = true
   ): Promise<DataView> => {
-    const savedObject = await this.savedObjectsClient.get<DataViewAttributes>(
-      DATA_VIEW_SAVED_OBJECT_TYPE,
-      id
-    );
+    const savedObject = await this.savedObjectsClient.get(DATA_VIEW_SAVED_OBJECT_TYPE, id);
 
     if (!savedObject.version) {
       throw new SavedObjectNotFound('data view', id, 'management/kibana/dataViews');

src/plugins/data_views/common/index.ts

@@ -13,6 +13,8 @@ export {
   DATA_VIEW_SAVED_OBJECT_TYPE,
 } from './constants';
 
+export { LATEST_VERSION } from './content_management';
+
 export type { ToSpecConfig } from './fields';
 export type { IIndexPatternFieldList } from './fields';
 export {

src/plugins/data_views/common/types.ts

@@ -267,13 +267,15 @@ export interface SavedObjectsClientCommon {
    * Search for saved objects
    * @param options - options for search
    */
-  find: <T = unknown>(options: SavedObjectsClientCommonFindArgs) => Promise<Array<SavedObject<T>>>;
+  find: (
+    options: SavedObjectsClientCommonFindArgs
+  ) => Promise<Array<SavedObject<DataViewAttributes>>>;
   /**
    * Get a single saved object by id
    * @param type - type of saved object
    * @param id - id of saved object
    */
-  get: <T = unknown>(type: string, id: string) => Promise<SavedObject<T>>;
+  get: (type: string, id: string) => Promise<SavedObject<DataViewAttributes>>;
   /**
    * Update a saved object by id
    * @param type - type of saved object
@@ -303,7 +305,7 @@ export interface SavedObjectsClientCommon {
    * @param type - type of saved object
    * @param id - id of saved object
    */
-  delete: (type: string, id: string) => Promise<{}>;
+  delete: (type: string, id: string) => Promise<unknown>; // todo remove unknown
 }
 
 export interface GetFieldsOptions {

src/plugins/data_views/kibana.jsonc

@@ -9,7 +9,8 @@
     "browser": true,
     "requiredPlugins": [
       "fieldFormats",
-      "expressions"
+      "expressions",
+      "contentManagement"
     ],
     "optionalPlugins": [
       "usageCollection"

src/plugins/data_views/public/plugin.ts

@@ -25,6 +25,8 @@ import { getIndices, HasData } from './services';
 
 import { debounceByKey } from './debounce_by_key';
 
+import { DATA_VIEW_SAVED_OBJECT_TYPE, LATEST_VERSION } from '../common';
+
 export class DataViewsPublicPlugin
   implements
     Plugin<
@@ -38,18 +40,26 @@ export class DataViewsPublicPlugin
 
   public setup(
     core: CoreSetup<DataViewsPublicStartDependencies, DataViewsPublicPluginStart>,
-    { expressions }: DataViewsPublicSetupDependencies
+    { expressions, contentManagement }: DataViewsPublicSetupDependencies
   ): DataViewsPublicPluginSetup {
     expressions.registerFunction(getIndexPatternLoad({ getStartServices: core.getStartServices }));
 
+    contentManagement.registry.register({
+      id: DATA_VIEW_SAVED_OBJECT_TYPE,
+      version: {
+        latest: LATEST_VERSION,
+      },
+      name: 'data view',
+    });
+
     return {};
   }
 
   public start(
     core: CoreStart,
-    { fieldFormats }: DataViewsPublicStartDependencies
+    { fieldFormats, contentManagement }: DataViewsPublicStartDependencies
   ): DataViewsPublicPluginStart {
-    const { uiSettings, http, notifications, savedObjects, application } = core;
+    const { uiSettings, http, notifications, application } = core;
 
     const onNotifDebounced = debounceByKey(
       notifications.toasts.add.bind(notifications.toasts),
@@ -63,7 +73,7 @@ export class DataViewsPublicPlugin
     return new DataViewsServicePublic({
       hasData: this.hasData.start(core),
       uiSettings: new UiSettingsPublicToCommon(uiSettings),
-      savedObjectsClient: new SavedObjectsClientPublicToCommon(savedObjects.client),
+      savedObjectsClient: new SavedObjectsClientPublicToCommon(contentManagement.client),
       apiClient: new DataViewsApiClient(http),
       fieldFormats,
       onNotification: (toastInputFields, key) => {