[SharedUxChromeNavigation] Use deeplink id instead of href

.github/CODEOWNERS

@@ -307,6 +307,16 @@ src/plugins/data_view_management @elastic/kibana-data-discovery
 src/plugins/data_views @elastic/kibana-data-discovery
 x-pack/plugins/data_visualizer @elastic/ml-ui
 packages/kbn-datemath @elastic/kibana-data-discovery
+packages/deeplinks/analytics @elastic/kibana-data-discovery
+packages/deeplinks/devtools @elastic/platform-deployment-management
+packages/deeplinks/management @elastic/platform-deployment-management @elastic/kibana-data-discovery
+packages/deeplinks/ml @elastic/ml-ui
+packages/deeplinks/observability @elastic/apm-ui
+packages/deeplinks/search @elastic/enterprise-search-frontend
+packages/default-nav/analytics @elastic/kibana-data-discovery
+packages/default-nav/devtools @elastic/platform-deployment-management
+packages/default-nav/management @elastic/platform-deployment-management @elastic/kibana-data-discovery
+packages/default-nav/ml @elastic/ml-ui
 packages/kbn-dev-cli-errors @elastic/kibana-operations
 packages/kbn-dev-cli-runner @elastic/kibana-operations
 packages/kbn-dev-proc-runner @elastic/kibana-operations

.i18nrc.json

@@ -19,6 +19,7 @@
     "data": "src/plugins/data",
     "observabilityAlertDetails": "x-pack/packages/observability/alert_details",
     "dataViews": "src/plugins/data_views",
+    "defaultNavigation": "packages/default-nav",
     "devTools": "src/plugins/dev_tools",
     "discover": "src/plugins/discover",
     "savedSearch": "src/plugins/saved_search",

package.json

@@ -353,6 +353,16 @@
     "@kbn/data-views-plugin": "link:src/plugins/data_views",
     "@kbn/data-visualizer-plugin": "link:x-pack/plugins/data_visualizer",
     "@kbn/datemath": "link:packages/kbn-datemath",
+    "@kbn/deeplinks-analytics": "link:packages/deeplinks/analytics",
+    "@kbn/deeplinks-devtools": "link:packages/deeplinks/devtools",
+    "@kbn/deeplinks-management": "link:packages/deeplinks/management",
+    "@kbn/deeplinks-ml": "link:packages/deeplinks/ml",
+    "@kbn/deeplinks-observability": "link:packages/deeplinks/observability",
+    "@kbn/deeplinks-search": "link:packages/deeplinks/search",
+    "@kbn/default-nav-analytics": "link:packages/default-nav/analytics",
+    "@kbn/default-nav-devtools": "link:packages/default-nav/devtools",
+    "@kbn/default-nav-management": "link:packages/default-nav/management",
+    "@kbn/default-nav-ml": "link:packages/default-nav/ml",
     "@kbn/dev-tools-plugin": "link:src/plugins/dev_tools",
     "@kbn/developer-examples-plugin": "link:examples/developer_examples",
     "@kbn/discover-enhanced-plugin": "link:x-pack/plugins/discover_enhanced",

packages/core/application/core-application-browser/src/application.ts

@@ -286,9 +286,9 @@ export type PublicAppDeepLinkInfo = Omit<
  * user-accessible.
  * @public
  */
-export type AppDeepLink = {
+export type AppDeepLink<Id extends string = string> = {
   /** Identifier to represent this sublink, should be unique for this application */
-  id: string;
+  id: Id;
   /** Title to label represent this deep link */
   title: string;
   /** Optional keywords to match with in deep links search. Omit if this part of the hierarchy does not have a page URL. */
@@ -303,13 +303,13 @@ export type AppDeepLink = {
         /** URL path to access this link, relative to the application's appRoute. */
         path: string;
         /** Optional array of links that are 'underneath' this section in the hierarchy */
-        deepLinks?: AppDeepLink[];
+        deepLinks?: Array<AppDeepLink<Id>>;
       }
     | {
         /** Optional path to access this section. Omit if this part of the hierarchy does not have a page URL. */
         path?: string;
         /** Array links that are 'underneath' this section in this hierarchy. */
-        deepLinks: AppDeepLink[];
+        deepLinks: Array<AppDeepLink<Id>>;
       }
   );
 

packages/core/chrome/core-chrome-browser/index.ts

@@ -7,6 +7,8 @@
  */
 
 export type {
+  AppDeepLinkId,
+  AppId,
   ChromeBadge,
   ChromeBreadcrumb,
   ChromeBreadcrumbsAppendExtension,
@@ -29,11 +31,12 @@ export type {
   ChromeStart,
   ChromeStyle,
   ChromeUserBanner,
-  ChromeProjectNavigationLink,
   ChromeProjectNavigation,
   ChromeProjectNavigationNode,
   SideNavCompProps,
   SideNavComponent,
   ChromeProjectBreadcrumb,
   ChromeSetProjectBreadcrumbsParams,
+  NodeDefinition,
+  NodeDefinitionWithChildren,
 } from './src';

packages/core/chrome/core-chrome-browser/src/index.ts

@@ -31,9 +31,12 @@ export type { ChromeBadge, ChromeUserBanner, ChromeStyle } from './types';
 export type {
   ChromeProjectNavigation,
   ChromeProjectNavigationNode,
-  ChromeProjectNavigationLink,
+  AppDeepLinkId,
+  AppId,
   SideNavCompProps,
   SideNavComponent,
   ChromeSetProjectBreadcrumbsParams,
   ChromeProjectBreadcrumb,
+  NodeDefinition,
+  NodeDefinitionWithChildren,
 } from './project_navigation';

packages/core/chrome/core-chrome-browser/src/project_navigation.ts

@@ -5,26 +5,43 @@
  * in compliance with, at your election, the Elastic License 2.0 or the Server
  * Side Public License, v 1.
  */
-
 import type { ComponentType } from 'react';
+import type { AppId as DevToolsApp, DeepLinkId as DevToolsLink } from '@kbn/deeplinks-devtools';
+import type {
+  AppId as AnalyticsApp,
+  DeepLinkId as AnalyticsDeepLink,
+} from '@kbn/deeplinks-analytics';
+import type { AppId as MlApp, DeepLinkId as MlLink } from '@kbn/deeplinks-ml';
+import type {
+  AppId as ManagementApp,
+  DeepLinkId as ManagementLink,
+} from '@kbn/deeplinks-management';
+import type { AppId as SearchApp, DeepLinkId as SearchLink } from '@kbn/deeplinks-search';
+import type {
+  AppId as ObservabilityApp,
+  DeepLinkId as ObservabilityLink,
+} from '@kbn/deeplinks-observability';
+
 import type { ChromeBreadcrumb } from './breadcrumb';
 import type { ChromeNavLink } from './nav_links';
 
-/** @internal */
-type AppId = string;
-
-/** @internal */
-type DeepLinkId = string;
-
-/** @internal */
-export type AppDeepLinkId = `${AppId}:${DeepLinkId}`;
+/** @public */
+export type AppId =
+  | DevToolsApp
+  | AnalyticsApp
+  | MlApp
+  | ManagementApp
+  | SearchApp
+  | ObservabilityApp;
 
-/**
- * @public
- *
- * App id or deeplink id
- */
-export type ChromeProjectNavigationLink = AppId | AppDeepLinkId;
+/** @public */
+export type AppDeepLinkId =
+  | AnalyticsDeepLink
+  | DevToolsLink
+  | MlLink
+  | ManagementLink
+  | SearchLink
+  | ObservabilityLink;
 
 /** @public */
 export interface ChromeProjectNavigationNode {
@@ -77,3 +94,48 @@ export type ChromeProjectBreadcrumb = ChromeBreadcrumb;
 export interface ChromeSetProjectBreadcrumbsParams {
   absolute: boolean;
 }
+
+type NonEmptyArray<T> = [T, ...T[]];
+
+/**
+ * @public
+ *
+ * A navigation node definition with its unique id, title, path in the tree and optional
+ * deep link and children.
+ * This definition serves to build the full ChromeProjectNavigation.navigationTree, converting
+ * "link" to "deepLink" and adding the "path" property for each node.
+ */
+export interface NodeDefinition<
+  LinkId extends AppDeepLinkId = AppDeepLinkId,
+  Id extends string = string,
+  ChildrenId extends string = Id
+> {
+  /** Optional id, if not passed a "link" must be provided. */
+  id?: Id;
+  /** Optional title. If not provided and a "link" is provided the title will be the Deep link title */
+  title?: string;
+  /** App id or deeplink id */
+  link?: LinkId;
+  /** Optional icon for the navigation node. Note: not all navigation depth will render the icon */
+  icon?: string;
+  /** Optional children of the navigation node */
+  children?: NonEmptyArray<NodeDefinition<LinkId, Id, ChildrenId>>;
+  /**
+   * Use href for absolute links only. Internal links should use "link".
+   */
+  href?: string;
+}
+
+/**
+ * @public
+ *
+ * A navigation node definition with its unique id, title, path in the tree and optional
+ * deep link and children.
+ */
+export type NodeDefinitionWithChildren<
+  LinkId extends AppDeepLinkId = AppDeepLinkId,
+  Id extends string = string,
+  ChildrenID extends string = Id
+> = NodeDefinition<LinkId, Id, ChildrenID> & {
+  children: Required<NodeDefinition<LinkId, Id, ChildrenID>>['children'];
+};

packages/core/chrome/core-chrome-browser/tsconfig.json

@@ -13,7 +13,13 @@
   ],
   "kbn_references": [
     "@kbn/core-mount-utils-browser",
-    "@kbn/core-application-common"
+    "@kbn/core-application-common",
+    "@kbn/deeplinks-devtools",
+    "@kbn/deeplinks-analytics",
+    "@kbn/deeplinks-ml",
+    "@kbn/deeplinks-management",
+    "@kbn/deeplinks-search",
+    "@kbn/deeplinks-observability"
   ],
   "exclude": [
     "target/**/*",

packages/deeplinks/analytics/README.md

@@ -0,0 +1,3 @@
+# @kbn/deeplinks-analytics
+
+Empty package generated by @kbn/generate

packages/deeplinks/analytics/constants.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 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 const DISCOVER_APP_ID = 'discover';
+
+export const DASHBOARD_APP_ID = 'dashboards';
+
+export const VISUALIZE_APP_ID = 'visualize';

packages/deeplinks/analytics/deep_links.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 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 { DASHBOARD_APP_ID, DISCOVER_APP_ID, VISUALIZE_APP_ID } from './constants';
+
+export type AppId = typeof DISCOVER_APP_ID | typeof DASHBOARD_APP_ID | typeof VISUALIZE_APP_ID;
+
+export type DeepLinkId = AppId;

packages/deeplinks/analytics/index.ts

@@ -0,0 +1,11 @@
+/*
+ * 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 { DASHBOARD_APP_ID, DISCOVER_APP_ID, VISUALIZE_APP_ID } from './constants';
+
+export type { AppId, DeepLinkId } from './deep_links';

packages/deeplinks/analytics/jest.config.js

@@ -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 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.
+ */
+
+module.exports = {
+  preset: '@kbn/test',
+  rootDir: '../../..',
+  roots: ['<rootDir>/packages/deeplinks/analytics'],
+};

packages/deeplinks/analytics/kibana.jsonc

@@ -0,0 +1,5 @@
+{
+  "type": "shared-common",
+  "id": "@kbn/deeplinks-analytics",
+  "owner": "@elastic/kibana-data-discovery"
+}

packages/deeplinks/analytics/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "@kbn/deeplinks-analytics",
+  "private": true,
+  "version": "1.0.0",
+  "license": "SSPL-1.0 OR Elastic License 2.0"
+}

packages/deeplinks/analytics/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "extends": "../../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "target/types",
+    "types": [
+      "jest",
+      "node",
+      "react"
+    ]
+  },
+  "include": [
+    "**/*.ts",
+    "**/*.tsx",
+  ],
+  "exclude": [
+    "target/**/*"
+  ],
+  "kbn_references": [
+  ]
+}

packages/deeplinks/devtools/README.md

@@ -0,0 +1,3 @@
+# @kbn/deeplinks-devtools
+
+Empty package generated by @kbn/generate

packages/deeplinks/devtools/constants.ts

@@ -0,0 +1,12 @@
+/*
+ * 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 { LinkId } from './deep_links';
+
+export const DEV_TOOLS_APP_ID = 'dev_tools';
+
+export const deepLinkIds: LinkId[] = ['searchprofiler', 'painless_lab', 'grokdebugger', 'console'];

packages/deeplinks/devtools/deep_links.ts

@@ -0,0 +1,15 @@
+/*
+ * 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 { DEV_TOOLS_APP_ID } from './constants';
+
+export type AppId = typeof DEV_TOOLS_APP_ID;
+
+export type LinkId = 'searchprofiler' | 'painless_lab' | 'grokdebugger' | 'console';
+
+export type DeepLinkId = AppId | `${AppId}:${LinkId}`;

packages/deeplinks/devtools/index.ts

@@ -0,0 +1,11 @@
+/*
+ * 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 { DEV_TOOLS_APP_ID, deepLinkIds } from './constants';
+
+export type { AppId, LinkId, DeepLinkId } from './deep_links';

packages/deeplinks/devtools/jest.config.js

@@ -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 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.
+ */
+
+module.exports = {
+  preset: '@kbn/test',
+  rootDir: '../../..',
+  roots: ['<rootDir>/packages/deeplinks/devtools'],
+};

packages/deeplinks/devtools/kibana.jsonc

@@ -0,0 +1,5 @@
+{
+  "type": "shared-common",
+  "id": "@kbn/deeplinks-devtools",
+  "owner": "@elastic/platform-deployment-management"
+}

packages/deeplinks/devtools/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "@kbn/deeplinks-devtools",
+  "private": true,
+  "version": "1.0.0",
+  "license": "SSPL-1.0 OR Elastic License 2.0"
+}