[Navigation embeddable] Add content management

packages/core/saved-objects/core-saved-objects-base-server-internal/src/constants.ts

@@ -77,6 +77,7 @@ export const DEFAULT_INDEX_TYPES_MAP: IndexTypesMap = {
     'ml-module',
     'ml-trained-model',
     'monitoring-telemetry',
+    'navigation_embeddable',
     'osquery-manager-usage-metric',
     'osquery-pack',
     'osquery-pack-asset',

packages/core/saved-objects/core-saved-objects-migration-server-internal/src/kibana_migrator_utils.fixtures.ts

@@ -1504,6 +1504,23 @@ export const INDEX_MAP_BEFORE_SPLIT: IndexMap = {
           },
         },
       },
+      navigation_embeddable: {
+        properties: {
+          id: {
+            type: 'text',
+          },
+          title: {
+            type: 'text',
+          },
+          description: {
+            type: 'text',
+          },
+          links: {
+            dynamic: false,
+            properties: {},
+          },
+        },
+      },
       'cases-comments': {
         dynamic: false,
         properties: {

packages/kbn-check-mappings-update-cli/current_mappings.json

@@ -1054,6 +1054,23 @@
       }
     }
   },
+  "navigation_embeddable": {
+    "properties": {
+      "id": {
+        "type": "text"
+      },
+      "title": {
+        "type": "text"
+      },
+      "description": {
+        "type": "text"
+      },
+      "links": {
+        "dynamic": false,
+        "properties": {}
+      }
+    }
+  },
   "lens": {
     "properties": {
       "title": {

src/core/server/integration_tests/saved_objects/migrations/group2/check_registered_types.test.ts

@@ -120,6 +120,7 @@ describe('checking migration metadata changes on all registered SO types', () =>
         "ml-module": "2225cbb4bd508ea5f69db4b848be9d8a74b60198",
         "ml-trained-model": "482195cefd6b04920e539d34d7356d22cb68e4f3",
         "monitoring-telemetry": "5d91bf75787d9d4dd2fae954d0b3f76d33d2e559",
+        "navigation_embeddable": "de71a127ed325261ca6bc926d93c4cd676d17a05",
         "observability-onboarding-state": "55b112d6a33fedb7c1e4fec4da768d2bcc5fadc2",
         "osquery-manager-usage-metric": "983bcbc3b7dda0aad29b20907db233abba709bcc",
         "osquery-pack": "6ab4358ca4304a12dcfc1777c8135b75cffb4397",

src/core/server/integration_tests/saved_objects/migrations/group5/dot_kibana_split.test.ts

@@ -240,6 +240,7 @@ describe('split .kibana index into multiple system indices', () => {
             "ml-module",
             "ml-trained-model",
             "monitoring-telemetry",
+            "navigation_embeddable",
             "observability-onboarding-state",
             "osquery-manager-usage-metric",
             "osquery-pack",

src/plugins/embeddable/public/lib/actions/edit_panel_action.ts

@@ -19,6 +19,7 @@ import {
   EmbeddableStateTransfer,
   EmbeddableInput,
   Container,
+  isReferenceOrValueEmbeddable,
 } from '../..';
 
 export const ACTION_EDIT_PANEL = 'editPanel';
@@ -94,6 +95,12 @@ export class EditPanelAction implements Action<ActionContext> {
       const oldExplicitInput = embeddable.getExplicitInput();
       const newExplicitInput = await factory.getExplicitInput(oldExplicitInput, embeddable.parent);
       embeddable.parent?.replaceEmbeddable(embeddable.id, newExplicitInput);
+      if (
+        isReferenceOrValueEmbeddable(embeddable) &&
+        embeddable.inputIsRefType(embeddable.getInput())
+      ) {
+        embeddable.reload();
+      }
       return;
     }
 

src/plugins/navigation_embeddable/common/constants.ts

@@ -0,0 +1,21 @@
+/*
+ * 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 { i18n } from '@kbn/i18n';
+
+export const LATEST_VERSION = 1;
+
+export const CONTENT_ID = 'navigation_embeddable';
+
+export const NAVIGATION_EMBEDDABLE_TYPE = 'navigation';
+
+export const APP_ICON = 'link';
+
+export const APP_NAME = i18n.translate('navigationEmbeddable.visTypeAlias.title', {
+  defaultMessage: 'Links',
+});

src/plugins/navigation_embeddable/common/content_management/cm_services.ts

@@ -0,0 +1,21 @@
+/*
+ * 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 {
+  ContentManagementServicesDefinition as ServicesDefinition,
+  Version,
+} from '@kbn/object-versioning';
+
+// We export the versioned service definition from this file and not the barrel to avoid adding
+// the schemas in the "public" js bundle
+
+import { serviceDefinition as v1 } from './v1/cm_services';
+
+export const cmServicesDefinition: { [version: Version]: ServicesDefinition } = {
+  1: v1,
+};

src/plugins/navigation_embeddable/common/content_management/index.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.
+ */
+
+export { LATEST_VERSION, CONTENT_ID } from '../constants';
+
+export type { NavigationEmbeddableContentType } from '../types';
+
+export type {
+  NavigationEmbeddableCrudTypes,
+  NavigationEmbeddableAttributes,
+  NavigationEmbeddableItem,
+  NavigationLinkType,
+  NavigationEmbeddableLink,
+} from './latest';
+
+export { DASHBOARD_LINK_TYPE, EXTERNAL_LINK_TYPE } from './latest';
+
+export * as NavigationEmbeddableV1 from './v1';

src/plugins/navigation_embeddable/common/content_management/latest.ts

@@ -0,0 +1,9 @@
+/*
+ * 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 * from './v1';

src/plugins/navigation_embeddable/common/content_management/v1/cm_services.ts

@@ -0,0 +1,108 @@
+/*
+ * 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 { schema } from '@kbn/config-schema';
+import type { ContentManagementServicesDefinition as ServicesDefinition } from '@kbn/object-versioning';
+import {
+  savedObjectSchema,
+  objectTypeToGetResultSchema,
+  createOptionsSchemas,
+  updateOptionsSchema,
+  createResultSchema,
+} from '@kbn/content-management-utils';
+import { DASHBOARD_LINK_TYPE, EXTERNAL_LINK_TYPE } from '.';
+
+const navigationEmbeddableLinkSchema = schema.object({
+  id: schema.string(),
+  type: schema.oneOf([schema.literal(DASHBOARD_LINK_TYPE), schema.literal(EXTERNAL_LINK_TYPE)]),
+  destination: schema.string(),
+  label: schema.maybe(schema.string()),
+  order: schema.number(),
+});
+
+const navigationEmbeddableAttributesSchema = schema.object(
+  {
+    title: schema.string(),
+    description: schema.maybe(schema.string()),
+    links: schema.maybe(schema.arrayOf(navigationEmbeddableLinkSchema)),
+  },
+  { unknowns: 'forbid' }
+);
+
+const navigationEmbeddableSavedObjectSchema = savedObjectSchema(
+  navigationEmbeddableAttributesSchema
+);
+
+const searchOptionsSchema = schema.maybe(
+  schema.object(
+    {
+      onlyTitle: schema.maybe(schema.boolean()),
+    },
+    { unknowns: 'forbid' }
+  )
+);
+
+const navigationEmbeddableCreateOptionsSchema = schema.object({
+  references: schema.maybe(createOptionsSchemas.references),
+  overwrite: createOptionsSchemas.overwrite,
+});
+
+const navigationEmbeddableUpdateOptionsSchema = schema.object({
+  references: updateOptionsSchema.references,
+});
+
+// Content management service definition.
+// We need it for BWC support between different versions of the content
+export const serviceDefinition: ServicesDefinition = {
+  get: {
+    out: {
+      result: {
+        schema: objectTypeToGetResultSchema(navigationEmbeddableSavedObjectSchema),
+      },
+    },
+  },
+  create: {
+    in: {
+      options: {
+        schema: navigationEmbeddableCreateOptionsSchema,
+      },
+      data: {
+        schema: navigationEmbeddableAttributesSchema,
+      },
+    },
+    out: {
+      result: {
+        schema: createResultSchema(navigationEmbeddableSavedObjectSchema),
+      },
+    },
+  },
+  update: {
+    in: {
+      options: {
+        schema: navigationEmbeddableUpdateOptionsSchema, // same schema as "create"
+      },
+      data: {
+        schema: navigationEmbeddableAttributesSchema,
+      },
+    },
+  },
+  search: {
+    in: {
+      options: {
+        schema: searchOptionsSchema,
+      },
+    },
+  },
+  mSearch: {
+    out: {
+      result: {
+        schema: navigationEmbeddableSavedObjectSchema,
+      },
+    },
+  },
+};

src/plugins/navigation_embeddable/common/content_management/v1/constants.ts

@@ -0,0 +1,17 @@
+/*
+ * 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.
+ */
+
+/**
+ * Dashboard to dashboard links
+ */
+export const DASHBOARD_LINK_TYPE = 'dashboardLink';
+
+/**
+ * External URL links
+ */
+export const EXTERNAL_LINK_TYPE = 'externalLink';

src/plugins/navigation_embeddable/common/content_management/v1/index.ts

@@ -0,0 +1,17 @@
+/*
+ * 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 { NavigationEmbeddableCrudTypes } from './types';
+export type {
+  NavigationEmbeddableCrudTypes,
+  NavigationEmbeddableAttributes,
+  NavigationEmbeddableLink,
+  NavigationLinkType,
+} from './types';
+export type NavigationEmbeddableItem = NavigationEmbeddableCrudTypes['Item'];
+export { DASHBOARD_LINK_TYPE, EXTERNAL_LINK_TYPE } from './constants';

src/plugins/navigation_embeddable/common/content_management/v1/types.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 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 {
+  ContentManagementCrudTypes,
+  SavedObjectCreateOptions,
+  SavedObjectUpdateOptions,
+} from '@kbn/content-management-utils';
+import { NavigationEmbeddableContentType } from '../../types';
+import { DASHBOARD_LINK_TYPE, EXTERNAL_LINK_TYPE } from './constants';
+
+export type NavigationEmbeddableCrudTypes = ContentManagementCrudTypes<
+  NavigationEmbeddableContentType,
+  NavigationEmbeddableAttributes,
+  Pick<SavedObjectCreateOptions, 'references'>,
+  Pick<SavedObjectUpdateOptions, 'references'>,
+  {
+    /** Flag to indicate to only search the text on the "title" field */
+    onlyTitle?: boolean;
+  }
+>;
+
+/**
+ * Navigation embeddable explicit input
+ */
+export type NavigationLinkType = typeof DASHBOARD_LINK_TYPE | typeof EXTERNAL_LINK_TYPE;
+
+export interface NavigationEmbeddableLink {
+  id: string;
+  type: NavigationLinkType;
+  destination: string;
+  label?: string;
+  order: number;
+}
+
+// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
+export type NavigationEmbeddableAttributes = {
+  title: string;
+  description?: string;
+  links?: NavigationEmbeddableLink[];
+};

src/plugins/navigation_embeddable/common/index.ts

@@ -0,0 +1,9 @@
+/*
+ * 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 { CONTENT_ID, LATEST_VERSION } from './constants';

src/plugins/navigation_embeddable/common/types.ts

@@ -0,0 +1,19 @@
+/*
+ * 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 { SavedObjectsResolveResponse } from '@kbn/core-saved-objects-api-server';
+
+export type NavigationEmbeddableContentType = 'navigation_embeddable';
+
+// TODO does this type need to be versioned?
+export interface SharingSavedObjectProps {
+  outcome: SavedObjectsResolveResponse['outcome'];
+  aliasTargetId?: SavedObjectsResolveResponse['alias_target_id'];
+  aliasPurpose?: SavedObjectsResolveResponse['alias_purpose'];
+  sourceId?: string;
+}