feat: add api package

feloy · feloy · commit def098154813 · 2025-10-31T15:09:58.000+01:00
Signed-off-by: Philippe Martin &lt;phmartin@redhat.com&gt;
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -68,6 +68,7 @@ jobs:
           sed -i  "s#version\":\ \"\(.*\)\",#version\":\ \"${{ steps.TAG_UTIL.outputs.extVersion }}\",#g" package.json
           sed -i  "s#version\":\ \"\(.*\)\",#version\":\ \"${{ steps.TAG_UTIL.outputs.extVersion }}\",#g" packages/extension/package.json
           sed -i  "s#version\":\ \"\(.*\)\",#version\":\ \"${{ steps.TAG_UTIL.outputs.extVersion }}\",#g" packages/webview/package.json
+          sed -i  "s#version\":\ \"\(.*\)\",#version\":\ \"${{ steps.TAG_UTIL.outputs.extVersion }}\",#g" packages/api/package.json
           sed -i "s#\(ghcr.io/podman-desktop/podman-desktop-extension-kubernetes-dashboard-builder:\)next#\1${{ steps.TAG_UTIL.outputs.extVersion }}#g" build/Containerfile
 
           git add package.json packages/extension/package.json packages/webview/package.json build/Containerfile
diff --git a/package.json b/package.json
@@ -31,6 +31,7 @@
   },
   "devDependencies": {
     "@eslint/compat": "^1.4.1",
+    "@tsconfig/strictest": "^2.0.6",
     "@typescript-eslint/eslint-plugin": "^8.46.1",
     "@typescript-eslint/parser": "^8.30.1",
     "@vitest/coverage-v8": "^3.2.2",
diff --git a/packages/api/package.json b/packages/api/package.json
@@ -0,0 +1,23 @@
+{
+  "name": "@podman-desktop/kubernetes-dashboard-extension-api",
+  "version": "0.2.0-next",
+  "description": "API for Kubernetes Dashboard extension",
+  "repository": "https://github.com/podman-desktop/extension-kubernetes-dashboard",
+  "publishConfig": {
+    "provenance": true,
+    "access": "public"
+  },
+  "license": "Apache-2.0",
+  "types": "./src/kubernetes-dashboard-extension-api.d.ts",
+  "files": [
+    "src"
+  ],
+  "scripts": {
+    "prepare": "",
+    "clean": "rimraf lib *.tsbuildinfo",
+    "build": "",
+    "watch": "",
+    "publish:next": "pnpm publish  --registry=https://registry.npmjs.org/ --no-git-tag-version --new-version 0.0.1-\"$(date +%s)\""
+  },
+  "dependencies": {}
+}
diff --git a/packages/api/src/kubernetes-dashboard-extension-api.d.ts b/packages/api/src/kubernetes-dashboard-extension-api.d.ts
@@ -16,7 +16,24 @@
  * SPDX-License-Identifier: Apache-2.0
  ***********************************************************************/
 
+export interface IDisposable {
+  dispose(): void;
+}
+
+export interface AvailableContextsInfo {
+  contextNames: string[];
+}
+
 export interface CurrentContextInfo {
   contextName?: string;
   namespace?: string;
 }
+
+export interface KubernetesDashboardSubscriber extends IDisposable {
+  onAvailableContexts(listener: (event: AvailableContextsInfo) => void): IDisposable;
+  onCurrentContext(listener: (event: CurrentContextInfo) => void): IDisposable;
+}
+
+export interface KubernetesDashboardExtensionApi {
+  getSubscriber(): KubernetesDashboardSubscriber;
+}
diff --git a/packages/api/tsconfig.json b/packages/api/tsconfig.json
@@ -0,0 +1,13 @@
+{
+  "extends": "@tsconfig/strictest/tsconfig.json",
+  "compilerOptions": {
+    "target": "esnext",
+    "module": "node16",
+    "baseUrl": ".",
+    "types": ["node"],
+    "strict": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": ["src/**/*.d.ts"]
+}
diff --git a/packages/api/vite.config.js b/packages/api/vite.config.js
@@ -15,7 +15,26 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  ***********************************************************************/
+/* eslint-env node */
+import { defineConfig } from 'vite';
 
-export interface AvailableContextsInfo {
-  contextNames: string[];
-}
+const PACKAGE_ROOT = __dirname;
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  mode: process.env.MODE,
+  root: PACKAGE_ROOT,
+  base: '',
+  server: {
+    fs: {
+      strict: true,
+    },
+  },
+  build: {
+    sourcemap: true,
+    outDir: 'dist',
+    assetsDir: '.',
+    emptyOutDir: true,
+    reportCompressedSize: false,
+  },
+});
diff --git a/packages/channels/package.json b/packages/channels/package.json
@@ -25,6 +25,7 @@
   },
   "devDependencies": {
     "@kubernetes-dashboard/rpc": "workspace:*",
+    "@podman-desktop/kubernetes-dashboard-extension-api": "workspace:*",
     "vite-plugin-dts": "^4.5.4"
   }
 }
diff --git a/packages/channels/src/channels.ts b/packages/channels/src/channels.ts
@@ -24,10 +24,8 @@ import type { PortForwardApi } from './interface/port-forward-api';
 import type { SubscribeApi } from './interface/subscribe-api';
 import type { SystemApi } from './interface/system-api';
 import type { ActiveResourcesCountInfo } from './model/active-resources-count-info';
-import type { AvailableContextsInfo } from './model/available-contexts-info';
 import type { ContextsHealthsInfo } from './model/contexts-healths-info';
 import type { ContextsPermissionsInfo } from './model/contexts-permissions-info';
-import type { CurrentContextInfo } from './model/current-context-info';
 import type { EndpointsInfo } from './model/endpoints-info';
 import type { KubernetesProvidersInfo } from './model/kubernetes-providers-info';
 import type { PodLogsChunk } from './model/pod-logs-chunk';
@@ -38,6 +36,7 @@ import type { ResourceEventsInfo } from './model/resource-events-info';
 import type { ResourcesCountInfo } from './model/resources-count-info';
 import type { UpdateResourceInfo } from './model/update-resource-info';
 import { createRpcChannel } from '@kubernetes-dashboard/rpc';
+import type { AvailableContextsInfo, CurrentContextInfo } from '@podman-desktop/kubernetes-dashboard-extension-api';
 
 // RPC channels (used by the webview to send requests to the extension)
 export const API_CONTEXTS = createRpcChannel<ContextsApi>('ContextsApi');
diff --git a/packages/channels/src/model/index.ts b/packages/channels/src/model/index.ts
@@ -17,13 +17,11 @@
  ***********************************************************************/
 
 export * from './active-resources-count-info';
-export * from './available-contexts-info';
 export * from './context-resource-events';
 export * from './context-resources-details';
 export * from './context-resources-items';
 export * from './contexts-healths-info';
 export * from './contexts-permissions-info';
-export * from './current-context-info';
 export * from './endpoint';
 export * from './endpoints-info';
 export * from './endpoints-options';
diff --git a/packages/extension/package.json b/packages/extension/package.json
@@ -42,7 +42,8 @@
     "vite": "^7.1",
     "vitest": "^3.1",
     "isomorphic-ws": "^5.0.0",
-    "@types/ws": "^8.18.0"
+    "@types/ws": "^8.18.0",
+    "@podman-desktop/kubernetes-dashboard-extension-api": "workspace:*"
   },
   "dependencies": {
     "@kubernetes/client-node": "^1.4.0",
diff --git a/packages/extension/src/dashboard-extension.ts b/packages/extension/src/dashboard-extension.ts
@@ -36,6 +36,8 @@ import {
   API_PORT_FORWARD,
   API_SUBSCRIBE,
   API_SYSTEM,
+  AVAILABLE_CONTEXTS,
+  CURRENT_CONTEXT,
   IDisposable,
 } from '@kubernetes-dashboard/channels';
 import { SystemApiImpl } from './manager/system-api';
@@ -46,6 +48,13 @@ import { PodTerminalsApiImpl } from './manager/pod-terminals-api-impl';
 import { NavigationApiImpl } from '/@/manager/navigation-api';
 import { KubernetesProvidersManager } from '/@/manager/kubernetes-providers';
 import { ChannelSubscriber } from './subscriber/channel-subscriber';
+import type {
+  AvailableContextsInfo,
+  CurrentContextInfo,
+  KubernetesDashboardExtensionApi,
+  KubernetesDashboardSubscriber,
+} from '@podman-desktop/kubernetes-dashboard-extension-api';
+import { ApiSubscriber } from '/@/subscriber/api-subscriber';
 
 export class DashboardExtension {
   #container: Container | undefined;
@@ -68,7 +77,7 @@ export class DashboardExtension {
     this.#extensionContext = extensionContext;
   }
 
-  async activate(): Promise<void> {
+  async activate(): Promise<KubernetesDashboardExtensionApi> {
     const telemetryLogger = env.createTelemetryLogger();
 
     const panel = await this.createWebview();
@@ -120,6 +129,24 @@ export class DashboardExtension {
         }
       }
     });
+
+    return {
+      getSubscriber: () => {
+        const subscriber = new ApiSubscriber();
+        this.#contextsStatesDispatcher.addSubscriber(subscriber);
+        return {
+          onAvailableContexts: (listener: (event: AvailableContextsInfo) => void): IDisposable => {
+            return subscriber.subscribe(AVAILABLE_CONTEXTS, undefined, listener);
+          },
+          onCurrentContext: (listener: (event: CurrentContextInfo) => void): IDisposable => {
+            return subscriber.subscribe(CURRENT_CONTEXT, undefined, listener);
+          },
+          dispose: () => {
+            subscriber.dispose();
+          },
+        } as KubernetesDashboardSubscriber;
+      },
+    } as KubernetesDashboardExtensionApi;
   }
 
   async deactivate(): Promise<void> {
diff --git a/packages/extension/src/dispatcher/available-contexts-dispatcher.ts b/packages/extension/src/dispatcher/available-contexts-dispatcher.ts
@@ -19,8 +19,9 @@
 import { inject, injectable } from 'inversify';
 import type { DispatcherObject } from './util/dispatcher-object';
 import { AbsDispatcherObjectImpl } from './util/dispatcher-object';
-import { type AvailableContextsInfo, AVAILABLE_CONTEXTS } from '@kubernetes-dashboard/channels';
+import { AVAILABLE_CONTEXTS } from '@kubernetes-dashboard/channels';
 import { ContextsManager } from '/@/manager/contexts-manager';
+import type { AvailableContextsInfo } from '@podman-desktop/kubernetes-dashboard-extension-api';
 
 @injectable()
 export class AvailableContextsDispatcher
diff --git a/packages/extension/src/dispatcher/current-context-dispatcher.ts b/packages/extension/src/dispatcher/current-context-dispatcher.ts
@@ -19,8 +19,9 @@
 import { inject, injectable } from 'inversify';
 import type { DispatcherObject } from './util/dispatcher-object';
 import { AbsDispatcherObjectImpl } from './util/dispatcher-object';
-import { CURRENT_CONTEXT, type CurrentContextInfo } from '@kubernetes-dashboard/channels';
+import { CURRENT_CONTEXT } from '@kubernetes-dashboard/channels';
 import { ContextsManager } from '/@/manager/contexts-manager';
+import type { CurrentContextInfo } from '@podman-desktop/kubernetes-dashboard-extension-api';
 
 @injectable()
 export class CurrentContextDispatcher
diff --git a/packages/extension/src/main.ts b/packages/extension/src/main.ts
@@ -19,14 +19,15 @@
 import type { ExtensionContext } from '@podman-desktop/api';
 
 import { DashboardExtension } from '/@/dashboard-extension';
+import type { KubernetesDashboardExtensionApi } from '@podman-desktop/kubernetes-dashboard-extension-api';
 
 let dashboardExtension: DashboardExtension | undefined;
 
 // Initialize the activation of the extension.
-export async function activate(extensionContext: ExtensionContext): Promise<void> {
+export async function activate(extensionContext: ExtensionContext): Promise<KubernetesDashboardExtensionApi> {
   dashboardExtension ??= new DashboardExtension(extensionContext);
 
-  await dashboardExtension.activate();
+  return dashboardExtension.activate();
 }
 
 export async function deactivate(): Promise<void> {
diff --git a/packages/extension/src/manager/contexts-states-dispatcher.ts b/packages/extension/src/manager/contexts-states-dispatcher.ts
@@ -118,6 +118,11 @@ export class ContextsStatesDispatcher {
     });
   }
 
+  addSubscriber(subscriber: StateSubscriber): void {
+    this.#subscribers.push(subscriber);
+    subscriber.onSubscribe(channelName => this.dispatchByChannelName(subscriber, channelName));
+  }
+
   // TODO replace this with an event
   getTroubleshootingInformation(): KubernetesTroubleshootingInformation {
     return this.manager.getTroubleshootingInformation();
diff --git a/packages/extension/src/subscriber/api-subscriber.ts b/packages/extension/src/subscriber/api-subscriber.ts
@@ -18,31 +18,31 @@
 
 import util from 'node:util';
 
-import { Disposable } from '@kubernetes-dashboard/channels';
+import { Disposable, type IDisposable } from '@kubernetes-dashboard/channels';
 import type { StateSubscriber } from './state-subscriber';
 import { Emitter, type Event } from '/@/types/emitter';
 import type { RpcChannel } from '@kubernetes-dashboard/rpc';
 
-interface ApiSubscriberInfo {
-  uid: symbol;
+interface ApiSubscriberInfo<T> {
   options: unknown;
+  listener: (event: T) => void;
 }
 
-export class ApiSubscriber implements StateSubscriber {
-  #subscribers: { [channelName: string]: ApiSubscriberInfo[] } = {};
+export class ApiSubscriber implements StateSubscriber, IDisposable {
+  #subscribers: { [channelName: string]: ApiSubscriberInfo<any>[] } = {}; // eslint-disable-line @typescript-eslint/no-explicit-any
 
   #onSubscribe = new Emitter<string>();
   onSubscribe: Event<string> = this.#onSubscribe.event;
 
-  subscribe(channelName: string, options: unknown): Disposable {
-    const uid = Symbol();
-    this.#subscribers[channelName] = [...(this.#subscribers[channelName] ?? []), { uid, options }];
+  subscribe<T>(channel: RpcChannel<T>, options: unknown, listener: (event: T) => void): Disposable {
+    const channelName = channel.name;
+    this.#subscribers[channelName] = [...(this.#subscribers[channelName] ?? []), { options, listener }];
 
     this.#onSubscribe.fire(channelName);
 
     return Disposable.create(() => {
       this.#subscribers[channelName] = (this.#subscribers[channelName] ?? []).filter(
-        subscriber => subscriber.uid !== uid,
+        subscriber => subscriber.listener !== listener,
       );
     });
   }
@@ -64,7 +64,17 @@ export class ApiSubscriber implements StateSubscriber {
     );
   }
 
-  async dispatch<T>(_channel: RpcChannel<T>, _data: T): Promise<void> {
-    // TODO implement
+  async dispatch<T>(channel: RpcChannel<T>, data: T): Promise<void> {
+    const subscriptions = this.#subscribers[channel.name];
+    if (!subscriptions) {
+      return;
+    }
+    for (const subscription of subscriptions) {
+      subscription.listener(data);
+    }
+  }
+
+  dispose(): void {
+    this.#subscribers = {};
   }
 }
diff --git a/packages/webview/package.json b/packages/webview/package.json
@@ -32,6 +32,7 @@
     "@fortawesome/free-solid-svg-icons": "^7.0.0",
     "@podman-desktop/ui-svelte": "1.22.1",
     "@podman-desktop/webview-api": "1.22.1",
+    "@podman-desktop/kubernetes-dashboard-extension-api": "workspace:*",
     "@sveltejs/vite-plugin-svelte": "^6",
     "@tailwindcss/typography": "^0.5.18",
     "@tailwindcss/vite": "^4.1.15",
diff --git a/packages/webview/src/App.spec.ts b/packages/webview/src/App.spec.ts
@@ -19,14 +19,14 @@
 import { render } from '@testing-library/svelte';
 import { StatesMocks } from '/@/tests/state-mocks';
 import { FakeStateObject } from '/@/state/util/fake-state-object.svelte';
-import type { AvailableContextsInfo, CurrentContextInfo } from '@kubernetes-dashboard/channels';
 import App from './App.svelte';
 import NoContextPage from './component/dashboard/NoContextPage.svelte';
 import NoSelectedContextPage from './component/dashboard/NoSelectedContextPage.svelte';
 import * as svelte from 'svelte';
 import type { WebviewApi } from '@podman-desktop/webview-api';
 import AppWithContext from '/@/AppWithContext.svelte';
 import { afterEach, beforeEach, expect, test, vi } from 'vitest';
+import type { CurrentContextInfo, AvailableContextsInfo } from '@podman-desktop/kubernetes-dashboard-extension-api';
 
 vi.mock(import('/@/component/dashboard/NoContextPage.svelte'));
 vi.mock(import('/@/component/dashboard/NoSelectedContextPage.svelte'));
diff --git a/packages/webview/src/component/connection/CheckConnection.spec.ts b/packages/webview/src/component/connection/CheckConnection.spec.ts
@@ -23,15 +23,11 @@ import { assert, beforeEach, expect, test, vi } from 'vitest';
 
 import { StatesMocks } from '/@/tests/state-mocks';
 import { FakeStateObject } from '/@/state/util/fake-state-object.svelte';
-import {
-  type CurrentContextInfo,
-  type ContextsHealthsInfo,
-  API_CONTEXTS,
-  type ContextsApi,
-} from '@kubernetes-dashboard/channels';
+import { type ContextsHealthsInfo, API_CONTEXTS, type ContextsApi } from '@kubernetes-dashboard/channels';
 import CheckConnection from './CheckConnection.svelte';
 import userEvent from '@testing-library/user-event';
 import { RemoteMocks } from '/@/tests/remote-mocks';
+import type { CurrentContextInfo } from '@podman-desktop/kubernetes-dashboard-extension-api';
 
 const statesMocks = new StatesMocks();
 const remoteMocks = new RemoteMocks();
diff --git a/packages/webview/src/component/connection/CurrentContextConnectionBadge.spec.ts b/packages/webview/src/component/connection/CurrentContextConnectionBadge.spec.ts
@@ -21,10 +21,11 @@ import '@testing-library/jest-dom/vitest';
 import { render, screen } from '@testing-library/svelte';
 import { tick } from 'svelte';
 import { beforeEach, describe, expect, test, vi } from 'vitest';
-import type { ContextsHealthsInfo, CurrentContextInfo } from '@kubernetes-dashboard/channels';
+import type { ContextsHealthsInfo } from '@kubernetes-dashboard/channels';
 import { StatesMocks } from '/@/tests/state-mocks';
 import { FakeStateObject } from '/@/state/util/fake-state-object.svelte';
 import CurrentContextConnectionBadge from './CurrentContextConnectionBadge.svelte';
+import type { CurrentContextInfo } from '@podman-desktop/kubernetes-dashboard-extension-api';
 
 const statesMocks = new StatesMocks();
 
diff --git a/packages/webview/src/component/dashboard/DashboardResourceCard.spec.ts b/packages/webview/src/component/dashboard/DashboardResourceCard.spec.ts
diff --git a/packages/webview/src/component/nodes/NodeDetails.spec.ts b/packages/webview/src/component/nodes/NodeDetails.spec.ts
diff --git a/packages/webview/src/component/objects/KubernetesEmptyScreen.spec.ts b/packages/webview/src/component/objects/KubernetesEmptyScreen.spec.ts
diff --git a/packages/webview/src/component/objects/KubernetesObjectDetails.spec.ts b/packages/webview/src/component/objects/KubernetesObjectDetails.spec.ts
diff --git a/packages/webview/src/component/objects/KubernetesObjectsList.spec.ts b/packages/webview/src/component/objects/KubernetesObjectsList.spec.ts
diff --git a/packages/webview/src/component/objects/NamespaceDropdown.spec.ts b/packages/webview/src/component/objects/NamespaceDropdown.spec.ts
diff --git a/packages/webview/src/component/pods/columns/OpenLinks.spec.ts b/packages/webview/src/component/pods/columns/OpenLinks.spec.ts
diff --git a/packages/webview/src/state/available-contexts.svelte.ts b/packages/webview/src/state/available-contexts.svelte.ts
diff --git a/packages/webview/src/state/current-context.svelte.ts b/packages/webview/src/state/current-context.svelte.ts
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,7 @@`
`25`	`25`	`},`
`26`	`26`	`"devDependencies": {`
`27`	`27`	`"@kubernetes-dashboard/rpc": "workspace:*",`
	`28`	`+ "@podman-desktop/kubernetes-dashboard-extension-api": "workspace:*",`
`28`	`29`	`"vite-plugin-dts": "^4.5.4"`
`29`	`30`	`}`
`30`	`31`	`}`