feat: add navigation api (#375)

Signed-off-by: Philippe Martin <[email protected]>

Author: feloy

packages/channels/src/channels.ts

@@ -17,6 +17,7 @@
  ***********************************************************************/
 
 import type { ContextsApi } from './interface/contexts-api';
+import type { NavigationApi } from './interface/navigation-api';
 import type { PodLogsApi } from './interface/pod-logs-api';
 import type { PodTerminalsApi } from './interface/pod-terminals-api';
 import type { PortForwardApi } from './interface/port-forward-api';
@@ -42,6 +43,7 @@ export const API_CONTEXTS = createRpcChannel<ContextsApi>('ContextsApi');
 export const API_SUBSCRIBE = createRpcChannel<SubscribeApi>('SubscribeApi');
 export const API_SYSTEM = createRpcChannel<SystemApi>('SystemApi');
 export const API_PORT_FORWARD = createRpcChannel<PortForwardApi>('PortForwardApi');
+export const API_NAVIGATION = createRpcChannel<NavigationApi>('NavigationApi');
 
 // Broadcast events (sent by extension and received by the webview)
 export const RESOURCES_COUNT = createRpcChannel<ResourcesCountInfo>('ResourcesCount');

packages/channels/src/interface/index.ts

@@ -22,6 +22,7 @@ import { type PodTerminalsApi } from './pod-terminals-api';
 import { type DeletePortForwardOptions, type PortForwardApi } from './port-forward-api';
 import { type SubscribeApi } from './subscribe-api';
 import { type SystemApi } from './system-api';
+import { type NavigationApi } from './navigation-api';
 
 export type {
   ContextsApi,
@@ -31,4 +32,5 @@ export type {
   SubscribeApi,
   SystemApi,
   DeletePortForwardOptions,
+  NavigationApi,
 };

packages/channels/src/interface/navigation-api.ts

@@ -0,0 +1,23 @@
+/**********************************************************************
+ * Copyright (C) 2025 Red Hat, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ ***********************************************************************/
+
+export const NavigationApi = Symbol.for('NavigationApi');
+
+export interface NavigationApi {
+  navigateToProviderNewConnection(id: string): Promise<void>;
+}

packages/extension/package.json

@@ -23,7 +23,7 @@
   "devDependencies": {
     "@kubernetes-dashboard/rpc": "workspace:*",
     "@kubernetes-dashboard/channels": "workspace:*",
-    "@podman-desktop/api": "1.22.0",
+    "@podman-desktop/api": "1.23.0-next.202510141447-e1ab0ef8faf",
     "@types/node": "^24",
     "@typescript-eslint/eslint-plugin": "^8.46.1",
     "@typescript-eslint/parser": "^8.30.1",

packages/extension/src/dashboard-extension.ts

@@ -30,6 +30,7 @@ import { InversifyBinding } from '/@/inject/inversify-binding';
 import type { Container } from 'inversify';
 import {
   API_CONTEXTS,
+  API_NAVIGATION,
   API_POD_LOGS,
   API_POD_TERMINALS,
   API_PORT_FORWARD,
@@ -42,6 +43,7 @@ import { PortForwardApiImpl } from './manager/port-forward-api-impl';
 import { PortForwardServiceProvider } from './port-forward/port-forward-service';
 import { PodLogsApiImpl } from './manager/pod-logs-api-impl';
 import { PodTerminalsApiImpl } from './manager/pod-terminals-api-impl';
+import { NavigationApiImpl } from '/@/manager/navigation-api';
 
 export class DashboardExtension {
   #container: Container | undefined;
@@ -56,6 +58,7 @@ export class DashboardExtension {
   #portForwardServiceProvider: PortForwardServiceProvider;
   #podLogsApiImpl: PodLogsApiImpl;
   #podTerminalsApiImpl: PodTerminalsApiImpl;
+  #navigationApiImpl: NavigationApiImpl;
 
   constructor(readonly extensionContext: ExtensionContext) {
     this.#extensionContext = extensionContext;
@@ -82,6 +85,7 @@ export class DashboardExtension {
     this.#portForwardServiceProvider = await this.#container.getAsync(PortForwardServiceProvider);
     this.#podLogsApiImpl = await this.#container.getAsync(PodLogsApiImpl);
     this.#podTerminalsApiImpl = await this.#container.getAsync(PodTerminalsApiImpl);
+    this.#navigationApiImpl = await this.#container.getAsync(NavigationApiImpl);
 
     const afterFirst = performance.now();
 
@@ -93,6 +97,7 @@ export class DashboardExtension {
     rpcExtension.registerInstance(API_PORT_FORWARD, this.#portForwardApiImpl);
     rpcExtension.registerInstance(API_POD_LOGS, this.#podLogsApiImpl);
     rpcExtension.registerInstance(API_POD_TERMINALS, this.#podTerminalsApiImpl);
+    rpcExtension.registerInstance(API_NAVIGATION, this.#navigationApiImpl);
 
     await this.listenMonitoring();
     await this.startMonitoring();

packages/extension/src/manager/_manager-module.ts

@@ -25,6 +25,7 @@ import { PortForwardApiImpl } from './port-forward-api-impl';
 import { PodLogsApiImpl } from './pod-logs-api-impl';
 import { IDisposable } from '@kubernetes-dashboard/channels';
 import { PodTerminalsApiImpl } from './pod-terminals-api-impl';
+import { NavigationApiImpl } from '/@/manager/navigation-api';
 
 const managersModule = new ContainerModule(options => {
   options.bind<ContextsManager>(ContextsManager).toSelf().inSingletonScope();
@@ -33,6 +34,7 @@ const managersModule = new ContainerModule(options => {
   options.bind<PortForwardApiImpl>(PortForwardApiImpl).toSelf().inSingletonScope();
   options.bind<PodLogsApiImpl>(PodLogsApiImpl).toSelf().inSingletonScope();
   options.bind<PodTerminalsApiImpl>(PodTerminalsApiImpl).toSelf().inSingletonScope();
+  options.bind<NavigationApiImpl>(NavigationApiImpl).toSelf().inSingletonScope();
 
   // Bind IDisposable to services which need to clear data/stop connection/etc when the panel is left
   // (the onDestroy are not called from components when the panel is left, which may introduce memory leaks if not disposed here)

packages/extension/src/manager/navigation-api.ts

@@ -0,0 +1,35 @@
+/**********************************************************************
+ * Copyright (C) 2025 Red Hat, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ ***********************************************************************/
+
+import { injectable } from 'inversify';
+import * as podmanDesktopApi from '@podman-desktop/api';
+import { NavigationApi } from '@kubernetes-dashboard/channels/dist/interface/navigation-api';
+
+@injectable()
+export class NavigationApiImpl implements NavigationApi {
+  async navigateToProviderNewConnection(id: string): Promise<void> {
+    // This test can be removed when the minimal version is set to 1.23
+    if (!('navigateToCreateProviderConnection' in podmanDesktopApi.navigation)) {
+      console.warn(
+        'navigating to provider page is not supported in this version of Podman Desktop, please upgrade to the latest version',
+      );
+      return;
+    }
+    return podmanDesktopApi.navigation.navigateToCreateProviderConnection(id);
+  }
+}