Add @kbn/data-views-as-code plugin

Author: AlexGPlay

package.json

@@ -578,6 +578,7 @@
     "@kbn/data-view-management-plugin": "link:src/platform/plugins/shared/data_view_management",
     "@kbn/data-view-utils": "link:src/platform/packages/shared/kbn-data-view-utils",
     "@kbn/data-view-validation": "link:src/platform/packages/shared/kbn-data-view-validation",
+    "@kbn/data-views-as-code-plugin": "link:src/platform/plugins/shared/data_views_as_code",
     "@kbn/data-views-plugin": "link:src/platform/plugins/shared/data_views",
     "@kbn/data-visualizer-plugin": "link:x-pack/platform/plugins/private/data_visualizer",
     "@kbn/dataset-quality-plugin": "link:x-pack/platform/plugins/shared/dataset_quality",

src/platform/plugins/shared/data_views_as_code/README.md

@@ -0,0 +1,5 @@
+# Data views as code
+
+This plugin contains the defined endpoints for data views as code, following the as code standards.
+
+Why a different plugin from `@kbn/data-views-plugin`? Because the as code utilities, schemas and transforms, rely on `@kbn/data-views-plugin` mainly for typing. This means that we can't reuse this utilities inside `@kbn/data-views-plugin` without causing a circular dependency. That can be fixed by creating a new package that relies on this pieces.

src/platform/plugins/shared/data_views_as_code/kibana.jsonc

@@ -0,0 +1,17 @@
+{
+  "type": "plugin",
+  "id": "@kbn/data-views-as-code-plugin",
+  "owner": ["@elastic/kibana-data-discovery"],
+  "group": "platform",
+  "visibility": "shared",
+  "description": "The data views as code plugin offers different endpoints following the as code standards",
+  "plugin": {
+    "id": "dataViewsAsCode",
+    "browser": false,
+    "server": true,
+    "requiredPlugins": ["dataViews"],
+    "optionalPlugins": [],
+    "requiredBundles": [],
+    "extraPublicDirs": []
+  }
+}

src/platform/plugins/shared/data_views_as_code/moon.yml

@@ -0,0 +1,18 @@
+# This file is generated by the @kbn/moon package. Any manual edits will be erased!
+#  To extend this, write your extensions/overrides to 'moon.extend.yml'
+#  then regenerate this file with: 'node scripts/regenerate_moon_projects.js --update --filter @kbn/visualization-listing-plugin'
+
+$schema: https://moonrepo.dev/schemas/project.json
+id: '@kbn/data-views-as-code-plugin'
+layer: unknown
+owners:
+  defaultOwner: '@elastic/kibana-data-discovery'
+toolchains:
+  default: node
+language: typescript
+project:
+  title: '@kbn/data-views-as-code-plugin'
+  description: Moon project for @kbn/data-views-as-code-plugin
+  channel: ''
+  owner: '@elastic/kibana-data-discovery'
+  sourceRoot: src/platform/plugins/shared/data_views_as_code

src/platform/plugins/shared/data_views_as_code/server/index.ts

@@ -0,0 +1,13 @@
+/*
+ * 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", the "GNU Affero General Public License v3.0 only", 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", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+export async function plugin() {
+  const { DataViewsAsCodeServerPlugin } = await import('./plugin');
+  return new DataViewsAsCodeServerPlugin();
+}

src/platform/plugins/shared/data_views_as_code/server/plugin.ts

@@ -0,0 +1,35 @@
+/*
+ * 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", the "GNU Affero General Public License v3.0 only", 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", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+import type { CoreSetup, Plugin } from '@kbn/core/server';
+import { registerRoutes } from './routes';
+import type {
+  DataViewsAsCodeServerPluginSetupDependencies,
+  DataViewsAsCodeServerPluginStartDependencies,
+} from './types';
+
+export class DataViewsAsCodeServerPlugin
+  implements
+    Plugin<
+      void,
+      void,
+      DataViewsAsCodeServerPluginSetupDependencies,
+      DataViewsAsCodeServerPluginStartDependencies
+    >
+{
+  public setup(core: CoreSetup<DataViewsAsCodeServerPluginStartDependencies, void>) {
+    registerRoutes({ http: core.http });
+  }
+
+  public start() {}
+
+  public stop() {}
+}
+
+export { DataViewsAsCodeServerPlugin as Plugin };

src/platform/plugins/shared/data_views_as_code/server/routes.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", the "GNU Affero General Public License v3.0 only", 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", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+import type { HttpServiceSetup } from '@kbn/core/server';
+export const INITIAL_REST_VERSION = '2023-10-31';
+
+interface RegisterRoutesArgs {
+  http: HttpServiceSetup;
+}
+
+export function registerRoutes(_: RegisterRoutesArgs) {
+  // The routes are going to be registered here at plugin setup
+  // 1. GET /api/data_views/{id}
+  // 2. POST /api/data_views
+  // 3. PUT /api/data_views/{id}
+  // 4. DELETE /api/data_views/{id}
+}

src/platform/plugins/shared/data_views_as_code/server/types.ts

@@ -0,0 +1,20 @@
+/*
+ * 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", the "GNU Affero General Public License v3.0 only", 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", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+import type {
+  DataViewsServerPluginSetup,
+  DataViewsServerPluginStart,
+} from '@kbn/data-views-plugin/server';
+
+export interface DataViewsAsCodeServerPluginSetupDependencies {
+  dataViews: DataViewsServerPluginSetup;
+}
+
+export interface DataViewsAsCodeServerPluginStartDependencies {
+  dataViews: DataViewsServerPluginStart;
+}

src/platform/plugins/shared/data_views_as_code/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "@kbn/tsconfig-base/tsconfig.json",
+  "compilerOptions": {
+    "outDir": "target/types"
+  },
+  "include": ["server/**/*"],
+  "kbn_references": ["@kbn/core", "@kbn/data-views-plugin"],
+  "exclude": ["target/**/*"]
+}

tsconfig.base.json

@@ -990,6 +990,8 @@
       "@kbn/data-view-utils/*": ["src/platform/packages/shared/kbn-data-view-utils/*"],
       "@kbn/data-view-validation": ["src/platform/packages/shared/kbn-data-view-validation"],
       "@kbn/data-view-validation/*": ["src/platform/packages/shared/kbn-data-view-validation/*"],
+      "@kbn/data-views-as-code-plugin": ["src/platform/plugins/shared/data_views_as_code"],
+      "@kbn/data-views-as-code-plugin/*": ["src/platform/plugins/shared/data_views_as_code/*"],
       "@kbn/data-views-plugin": ["src/platform/plugins/shared/data_views"],
       "@kbn/data-views-plugin/*": ["src/platform/plugins/shared/data_views/*"],
       "@kbn/data-visualizer-plugin": ["x-pack/platform/plugins/private/data_visualizer"],