add SavedObjectType.management.displayName

docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.displayname.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [SavedObjectsTypeManagementDefinition](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.md) &gt; [displayName](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.displayname.md)
+
+## SavedObjectsTypeManagementDefinition.displayName property
+
+When specified, will be used instead of the type's name in SO management section's labels.
+
+<b>Signature:</b>
+
+```typescript
+displayName?: string;
+```

docs/development/core/server/kibana-plugin-core-server.savedobjectstypemanagementdefinition.md

@@ -17,6 +17,7 @@ export interface SavedObjectsTypeManagementDefinition<Attributes = any>
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [defaultSearchField](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.defaultsearchfield.md) | <code>string</code> | The default search field to use for this type. Defaults to <code>id</code>. |
+|  [displayName](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.displayname.md) | <code>string</code> | When specified, will be used instead of the type's name in SO management section's labels. |
 |  [getEditUrl](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.getediturl.md) | <code>(savedObject: SavedObject&lt;Attributes&gt;) =&gt; string</code> | Function returning the url to use to redirect to the editing page of this object. If not defined, editing will not be allowed. |
 |  [getInAppUrl](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.getinappurl.md) | <code>(savedObject: SavedObject&lt;Attributes&gt;) =&gt; {</code><br/><code>        path: string;</code><br/><code>        uiCapabilitiesPath: string;</code><br/><code>    }</code> | Function returning the url to use to redirect to this object from the management section. If not defined, redirecting to the object will not be allowed. |
 |  [getTitle](./kibana-plugin-core-server.savedobjectstypemanagementdefinition.gettitle.md) | <code>(savedObject: SavedObject&lt;Attributes&gt;) =&gt; string</code> | Function returning the title to display in the management table. If not defined, will use the object's type and id to generate a label. |

src/core/server/saved_objects/types.ts

@@ -356,6 +356,10 @@ export interface SavedObjectsTypeManagementDefinition<Attributes = any> {
    * Is the type importable or exportable. Defaults to `false`.
    */
   importableAndExportable?: boolean;
+  /**
+   * When specified, will be used instead of the type's name in SO management section's labels.
+   */
+  displayName?: string;
   /**
    * When set to false, the type will not be listed or searchable in the SO management section.
    * Main usage of setting this property to false for a type is when objects from the type should

src/core/server/server.api.md

@@ -2739,6 +2739,7 @@ export interface SavedObjectsType<Attributes = any> {
 // @public
 export interface SavedObjectsTypeManagementDefinition<Attributes = any> {
     defaultSearchField?: string;
+    displayName?: string;
     getEditUrl?: (savedObject: SavedObject<Attributes>) => string;
     getInAppUrl?: (savedObject: SavedObject<Attributes>) => {
         path: string;

src/plugins/saved_objects_management/common/index.ts

@@ -13,4 +13,5 @@ export type {
   SavedObjectRelationKind,
   SavedObjectInvalidRelation,
   SavedObjectGetRelationshipsResponse,
+  SavedObjectManagementTypeInfo,
 } from './types';

src/plugins/saved_objects_management/common/types.ts

@@ -6,8 +6,8 @@
  * Side Public License, v 1.
  */
 
-import { SavedObject } from 'src/core/types';
-import { SavedObjectsNamespaceType } from 'src/core/public';
+import type { SavedObject } from 'src/core/types';
+import type { SavedObjectsNamespaceType } from 'src/core/public';
 
 /**
  * The metadata injected into a {@link SavedObject | saved object} when returning
@@ -52,3 +52,10 @@ export interface SavedObjectGetRelationshipsResponse {
   relations: SavedObjectRelation[];
   invalidRelations: SavedObjectInvalidRelation[];
 }
+
+export interface SavedObjectManagementTypeInfo {
+  name: string;
+  namespaceType: SavedObjectsNamespaceType;
+  hidden: boolean;
+  displayName: string;
+}

src/plugins/saved_objects_management/public/lib/get_allowed_types.ts

@@ -6,13 +6,14 @@
  * Side Public License, v 1.
  */
 
-import { HttpStart } from 'src/core/public';
+import type { HttpStart } from 'src/core/public';
+import type { SavedObjectManagementTypeInfo } from '../../common/types';
 
 interface GetAllowedTypesResponse {
-  types: string[];
+  types: SavedObjectManagementTypeInfo[];
 }
 
-export async function getAllowedTypes(http: HttpStart) {
+export async function getAllowedTypes(http: HttpStart): Promise<SavedObjectManagementTypeInfo[]> {
   const response = await http.get<GetAllowedTypesResponse>(
     '/api/kibana/management/saved_objects/_allowed_types'
   );

src/plugins/saved_objects_management/public/lib/get_saved_object_label.test.ts

@@ -0,0 +1,31 @@
+/*
+ * 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 { SavedObjectManagementTypeInfo } from '../../common/types';
+import { getSavedObjectLabel } from './get_saved_object_label';
+
+const toTypeInfo = (name: string, displayName?: string): SavedObjectManagementTypeInfo => ({
+  name,
+  displayName: displayName ?? name,
+  hidden: false,
+  namespaceType: 'single',
+});
+
+describe('getSavedObjectLabel', () => {
+  it('returns the type name if no types are provided', () => {
+    expect(getSavedObjectLabel('foo', [])).toEqual('foo');
+  });
+
+  it('returns the type name if type does not specify a display name', () => {
+    expect(getSavedObjectLabel('foo', [toTypeInfo('foo')])).toEqual('foo');
+  });
+
+  it('returns the type display name if type does specify a display name', () => {
+    expect(getSavedObjectLabel('foo', [toTypeInfo('foo', 'fooDisplay')])).toEqual('fooDisplay');
+  });
+});

src/plugins/saved_objects_management/public/lib/get_saved_object_label.ts

@@ -6,13 +6,12 @@
  * Side Public License, v 1.
  */
 
-export function getSavedObjectLabel(type: string) {
-  switch (type) {
-    case 'index-pattern':
-    case 'index-patterns':
-    case 'indexPatterns':
-      return 'index patterns';
-    default:
-      return type;
-  }
+import type { SavedObjectManagementTypeInfo } from '../../common/types';
+
+/**
+ * Returns the label to be used for given saved object type.
+ */
+export function getSavedObjectLabel(type: string, types: SavedObjectManagementTypeInfo[]) {
+  const typeInfo = types.find((t) => t.name === type);
+  return typeInfo?.displayName ?? type;
 }

src/plugins/saved_objects_management/public/management_section/mount_section.tsx

@@ -14,6 +14,7 @@ import { i18n } from '@kbn/i18n';
 import { EuiLoadingSpinner } from '@elastic/eui';
 import { CoreSetup } from 'src/core/public';
 import { ManagementAppMountParams } from '../../../management/public';
+import type { SavedObjectManagementTypeInfo } from '../../common/types';
 import { StartDependencies, SavedObjectsManagementPluginStart } from '../plugin';
 import { getAllowedTypes } from './../lib';
 
@@ -22,7 +23,7 @@ interface MountParams {
   mountParams: ManagementAppMountParams;
 }
 
-let allowedObjectTypes: string[] | undefined;
+let allowedObjectTypes: SavedObjectManagementTypeInfo[] | undefined;
 
 const title = i18n.translate('savedObjectsManagement.objects.savedObjectsTitle', {
   defaultMessage: 'Saved Objects',
@@ -33,15 +34,15 @@ const SavedObjectsTablePage = lazy(() => import('./saved_objects_table_page'));
 export const mountManagementSection = async ({ core, mountParams }: MountParams) => {
   const [coreStart, { data, savedObjectsTaggingOss, spaces: spacesApi }, pluginStart] =
     await core.getStartServices();
+  const { capabilities } = coreStart.application;
   const { element, history, setBreadcrumbs } = mountParams;
-  if (allowedObjectTypes === undefined) {
+
+  if (!allowedObjectTypes) {
     allowedObjectTypes = await getAllowedTypes(coreStart.http);
   }
 
   coreStart.chrome.docTitle.change(title);
 
-  const capabilities = coreStart.application.capabilities;
-
   const RedirectToHomeIfUnauthorized: React.FunctionComponent = ({ children }) => {
     const allowed = capabilities?.management?.kibana?.objects ?? false;
 

src/plugins/saved_objects_management/public/management_section/objects_table/components/delete_confirm_modal.test.tsx

@@ -9,7 +9,7 @@
 import React from 'react';
 import { findTestSubject } from '@elastic/eui/lib/test';
 import { mountWithIntl } from '@kbn/test/jest';
-import { SavedObjectWithMetadata } from '../../../../common';
+import type { SavedObjectWithMetadata, SavedObjectManagementTypeInfo } from '../../../../common';
 import { DeleteConfirmModal } from './delete_confirm_modal';
 
 interface CreateObjectOptions {
@@ -32,6 +32,7 @@ const createObject = ({
 });
 
 describe('DeleteConfirmModal', () => {
+  const allowedTypes: SavedObjectManagementTypeInfo[] = [];
   let onConfirm: jest.Mock;
   let onCancel: jest.Mock;
 
@@ -47,6 +48,7 @@ describe('DeleteConfirmModal', () => {
         onConfirm={onConfirm}
         onCancel={onCancel}
         selectedObjects={[]}
+        allowedTypes={allowedTypes}
       />
     );
     expect(wrapper.find('EuiLoadingElastic')).toHaveLength(1);
@@ -61,6 +63,7 @@ describe('DeleteConfirmModal', () => {
         onConfirm={onConfirm}
         onCancel={onCancel}
         selectedObjects={objs}
+        allowedTypes={allowedTypes}
       />
     );
     expect(wrapper.find('.euiTableRow')).toHaveLength(3);
@@ -73,6 +76,7 @@ describe('DeleteConfirmModal', () => {
         onConfirm={onConfirm}
         onCancel={onCancel}
         selectedObjects={[]}
+        allowedTypes={allowedTypes}
       />
     );
     wrapper.find('EuiButtonEmpty').simulate('click');
@@ -88,6 +92,7 @@ describe('DeleteConfirmModal', () => {
         onConfirm={onConfirm}
         onCancel={onCancel}
         selectedObjects={[createObject()]}
+        allowedTypes={allowedTypes}
       />
     );
     wrapper.find('EuiButton').simulate('click');
@@ -109,6 +114,7 @@ describe('DeleteConfirmModal', () => {
           onConfirm={onConfirm}
           onCancel={onCancel}
           selectedObjects={objs}
+          allowedTypes={allowedTypes}
         />
       );
       expect(wrapper.find('.euiTableRow')).toHaveLength(1);
@@ -126,6 +132,7 @@ describe('DeleteConfirmModal', () => {
           onConfirm={onConfirm}
           onCancel={onCancel}
           selectedObjects={objs}
+          allowedTypes={allowedTypes}
         />
       );
 
@@ -145,6 +152,7 @@ describe('DeleteConfirmModal', () => {
           onConfirm={onConfirm}
           onCancel={onCancel}
           selectedObjects={objs}
+          allowedTypes={allowedTypes}
         />
       );
 
@@ -164,6 +172,7 @@ describe('DeleteConfirmModal', () => {
           onConfirm={onConfirm}
           onCancel={onCancel}
           selectedObjects={objs}
+          allowedTypes={allowedTypes}
         />
       );
 
@@ -184,6 +193,7 @@ describe('DeleteConfirmModal', () => {
           onConfirm={onConfirm}
           onCancel={onCancel}
           selectedObjects={objs}
+          allowedTypes={allowedTypes}
         />
       );
       const callout = findTestSubject(wrapper, 'sharedObjectsWarning');
@@ -202,6 +212,7 @@ describe('DeleteConfirmModal', () => {
           onConfirm={onConfirm}
           onCancel={onCancel}
           selectedObjects={objs}
+          allowedTypes={allowedTypes}
         />
       );
       const callout = findTestSubject(wrapper, 'sharedObjectsWarning');