@kite-dev/plugin-sdk 0.0.1

package/dist/host-runtime.d.ts

@@ -0,0 +1,26 @@
+import React from 'react';
+import type { ButtonProps, KubeResourceTableProps, KitePluginHostRuntime, LogsViewerProps, PageProps, PanelProps, PluginOperationParams, PluginResourceDefinition, ResourceTableProps, SectionProps, SimpleResourceDetailProps, SimpleTableProps, TerminalProps } from './types';
+declare global {
+    interface Window {
+        __KITE_PLUGIN_HOST__?: KitePluginHostRuntime;
+    }
+}
+export declare function defineKitePlugin<T>(setup: T): T;
+export declare function ResourceTable<T>(props: ResourceTableProps<T>): React.ReactElement | null;
+export declare function SimpleTable<T>(props: SimpleTableProps<T>): React.ReactElement | null;
+export declare function KubeResourceTable<T>(props: KubeResourceTableProps<T>): React.ReactElement | null;
+export declare const SimpleResourceDetail: (props: SimpleResourceDetailProps) => React.ReactElement<any, string | React.JSXElementConstructor<any>>;
+export declare const LogsViewer: (props: LogsViewerProps) => React.ReactElement<any, string | React.JSXElementConstructor<any>>;
+export declare const Terminal: (props: TerminalProps) => React.ReactElement<any, string | React.JSXElementConstructor<any>>;
+export declare const Page: (props: PageProps) => React.ReactElement<any, string | React.JSXElementConstructor<any>>;
+export declare const Section: (props: SectionProps) => React.ReactElement<any, string | React.JSXElementConstructor<any>>;
+export declare const Button: (props: ButtonProps) => React.ReactElement<any, string | React.JSXElementConstructor<any>>;
+export declare const Panel: (props: PanelProps) => React.ReactElement<any, string | React.JSXElementConstructor<any>>;
+export declare function getResource<T = unknown>(resource: PluginResourceDefinition, params: PluginOperationParams): Promise<T>;
+export declare function updateResource<T = unknown>(resource: PluginResourceDefinition, params: PluginOperationParams, body: T): Promise<void>;
+export declare function patchResource<T = unknown>(resource: PluginResourceDefinition, params: PluginOperationParams, body: T): Promise<void>;
+export declare function deleteResource(resource: PluginResourceDefinition, params: PluginOperationParams, options?: {
+    force?: boolean;
+    wait?: boolean;
+}): Promise<void>;
+export type * from './types';

package/dist/host-runtime.js

@@ -0,0 +1,46 @@
+import React from 'react';
+const getHost = () => {
+    const host = window.__KITE_PLUGIN_HOST__;
+    if (!host) {
+        throw new Error('Kite plugin host runtime is not ready');
+    }
+    return host;
+};
+const createComponentProxy = (key) => (props) => {
+    const Component = getHost().components[key];
+    return React.createElement(Component, props);
+};
+export function defineKitePlugin(setup) {
+    return setup;
+}
+export function ResourceTable(props) {
+    const Component = getHost().components.ResourceTable;
+    return React.createElement(Component, props);
+}
+export function SimpleTable(props) {
+    const Component = getHost().components.SimpleTable;
+    return React.createElement(Component, props);
+}
+export function KubeResourceTable(props) {
+    const Component = getHost().components.KubeResourceTable;
+    return React.createElement(Component, props);
+}
+export const SimpleResourceDetail = createComponentProxy('SimpleResourceDetail');
+export const LogsViewer = createComponentProxy('LogsViewer');
+export const Terminal = createComponentProxy('Terminal');
+export const Page = createComponentProxy('Page');
+export const Section = createComponentProxy('Section');
+export const Button = createComponentProxy('Button');
+export const Panel = createComponentProxy('Panel');
+export function getResource(resource, params) {
+    return getHost().api.getResource(resource, params);
+}
+export function updateResource(resource, params, body) {
+    return getHost().api.updateResource(resource, params, body);
+}
+export function patchResource(resource, params, body) {
+    return getHost().api.patchResource(resource, params, body);
+}
+export function deleteResource(resource, params, options) {
+    return getHost().api.deleteResource(resource, params, options);
+}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './host-runtime';

package/dist/index.js

@@ -0,0 +1 @@
+export * from './host-runtime';

package/dist/types.d.ts

@@ -0,0 +1,227 @@
+import type { ButtonHTMLAttributes, ComponentType, HTMLAttributes, ReactNode } from 'react';
+export type PluginMenuGroupId = 'plugin';
+export type PluginResourceScope = 'namespaced' | 'cluster';
+export interface BuiltinPluginResource {
+    source: 'builtin';
+    resourceType: string;
+    scope: PluginResourceScope;
+}
+export interface CRDPluginResource {
+    source: 'crd';
+    crdName: string;
+    kind: string;
+    scope: PluginResourceScope;
+}
+export type PluginResourceDefinition = BuiltinPluginResource | CRDPluginResource;
+export interface PluginMenuDefinition {
+    groupId: PluginMenuGroupId;
+    title: string;
+    icon?: string;
+    after?: string;
+}
+export interface PluginRegistryListEntry {
+    routerName: string;
+    title: string;
+    resource: PluginResourceDefinition;
+    menu: PluginMenuDefinition;
+}
+export interface PluginRegistryDetailEntry {
+    routerName: string;
+    resource: PluginResourceDefinition;
+}
+export interface PluginRegistryEntry {
+    id: string;
+    name: string;
+    version: string;
+    enabled: boolean;
+    entry: string;
+    lists?: PluginRegistryListEntry[];
+    details?: PluginRegistryDetailEntry[];
+}
+export interface PluginManifest {
+    schemaVersion: string;
+    id: string;
+    name: string;
+    version: string;
+    sdkVersionRange: string;
+    hostVersionRange: string;
+    entry: string;
+    lists?: PluginRegistryListEntry[];
+    details?: PluginRegistryDetailEntry[];
+}
+export type InstalledPluginStatus = 'enabled' | 'disabled' | 'failed';
+export interface InstalledPlugin {
+    id: number;
+    pluginId: string;
+    name: string;
+    version: string;
+    enabled: boolean;
+    status: InstalledPluginStatus;
+    manifestUrl: string;
+    assetUrl: string;
+    sdkVersionRange: string;
+    hostVersionRange: string;
+    errorMessage?: string;
+    installSource: string;
+    manifest?: PluginManifest;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface PluginOperationParams {
+    name: string;
+    namespace?: string;
+}
+export interface ResourceTableColumn<T> {
+    header: string;
+    render: (item: T, index: number) => ReactNode;
+    align?: 'left' | 'center' | 'right';
+}
+export interface ResourceTableProps<T> {
+    title?: ReactNode;
+    items: T[];
+    columns: ResourceTableColumn<T>[];
+    isLoading?: boolean;
+    error?: unknown;
+    emptyMessage?: string;
+    searchPlaceholder?: string;
+    searchText?: (item: T) => string;
+    getRowKey?: (item: T, index: number) => string;
+    onRefresh?: () => void | Promise<void>;
+    toolbar?: ReactNode;
+    namespace?: string;
+    setNamespace?: (namespace: string) => void;
+    clusterScope?: boolean;
+}
+export interface SimpleTableColumn<T> {
+    header: string;
+    accessor: (item: T) => unknown;
+    cell: (value: unknown, item: T) => ReactNode;
+    align?: 'left' | 'center' | 'right';
+}
+export interface SimpleTableProps<T> {
+    data: T[];
+    columns: SimpleTableColumn<T>[];
+    emptyMessage?: string;
+}
+export interface PageProps {
+    title?: ReactNode;
+    description?: ReactNode;
+    actions?: ReactNode;
+    children?: ReactNode;
+}
+export interface SectionProps {
+    title?: ReactNode;
+    description?: ReactNode;
+    children?: ReactNode;
+}
+export type ButtonProps = ButtonHTMLAttributes<HTMLButtonElement> & {
+    variant?: 'default' | 'destructive' | 'outline' | 'secondary' | 'ghost' | 'link';
+    size?: 'default' | 'sm' | 'lg' | 'icon';
+};
+export type PanelProps = HTMLAttributes<HTMLDivElement>;
+export interface SimpleResourceDetailProps {
+    resourceType: string;
+    name: string;
+    namespace?: string;
+}
+export interface KubeResourceTableProps<T> {
+    resourceName: string;
+    resourceType?: string;
+    columns: unknown[];
+    clusterScope?: boolean;
+    searchQueryFilter?: (item: T, query: string) => boolean;
+    showCreateButton?: boolean;
+    onCreateClick?: () => void;
+    extraToolbars?: ReactNode[];
+    defaultHiddenColumns?: string[];
+}
+export interface PluginListPageProps<T = unknown> {
+    items: T[];
+    isLoading: boolean;
+    error?: unknown;
+    namespace?: string;
+    setNamespace?: (namespace: string) => void;
+    refetch: () => Promise<unknown> | unknown;
+    routeBase: string;
+    resource: PluginResourceDefinition;
+}
+export interface PluginDetailPageProps<T = unknown> {
+    item: T | null;
+    isLoading: boolean;
+    error?: unknown;
+    refetch: () => Promise<unknown> | unknown;
+    routeBase: string;
+    resource: PluginResourceDefinition;
+}
+export interface ResourceListRegistration<T = unknown> {
+    routerName: string;
+    component: ComponentType<PluginListPageProps<T>>;
+}
+export interface ResourceDetailRegistration<T = unknown> {
+    routerName: string;
+    component: ComponentType<PluginDetailPageProps<T>>;
+}
+export interface KitePluginSetupApi {
+    registerResourceList: <T = unknown>(def: ResourceListRegistration<T>) => void;
+    registerResourceDetail: <T = unknown>(def: ResourceDetailRegistration<T>) => void;
+}
+export interface LogsViewerProps {
+    namespace: string;
+    podName?: string;
+    pods?: Array<{
+        metadata?: {
+            name?: string;
+        };
+    }>;
+    labelSelector?: string;
+    containers?: Array<{
+        name: string;
+    }>;
+    initContainers?: Array<{
+        name: string;
+    }>;
+    onClose?: () => void;
+}
+export interface TerminalProps {
+    type?: 'node' | 'pod' | 'kubectl';
+    namespace?: string;
+    podName?: string;
+    nodeName?: string;
+    pods?: Array<{
+        metadata?: {
+            name?: string;
+        };
+    }>;
+    containers?: Array<{
+        name: string;
+    }>;
+    initContainers?: Array<{
+        name: string;
+    }>;
+    embedded?: boolean;
+}
+export interface KitePluginHostAPI {
+    getResource: <T = unknown>(resource: PluginResourceDefinition, params: PluginOperationParams) => Promise<T>;
+    updateResource: <T = unknown>(resource: PluginResourceDefinition, params: PluginOperationParams, body: T) => Promise<void>;
+    patchResource: <T = unknown>(resource: PluginResourceDefinition, params: PluginOperationParams, body: T) => Promise<void>;
+    deleteResource: (resource: PluginResourceDefinition, params: PluginOperationParams, options?: {
+        force?: boolean;
+        wait?: boolean;
+    }) => Promise<void>;
+}
+export interface KitePluginHostComponents {
+    ResourceTable: ComponentType<ResourceTableProps<unknown>>;
+    SimpleTable: ComponentType<SimpleTableProps<unknown>>;
+    SimpleResourceDetail: ComponentType<SimpleResourceDetailProps>;
+    KubeResourceTable: ComponentType<KubeResourceTableProps<unknown>>;
+    LogsViewer: ComponentType<LogsViewerProps>;
+    Terminal: ComponentType<TerminalProps>;
+    Page: ComponentType<PageProps>;
+    Section: ComponentType<SectionProps>;
+    Button: ComponentType<ButtonProps>;
+    Panel: ComponentType<PanelProps>;
+}
+export interface KitePluginHostRuntime {
+    api: KitePluginHostAPI;
+    components: KitePluginHostComponents;
+}

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@kite-dev/plugin-sdk",
+  "version": "0.0.1",
+  "type": "module",
+  "main": "./dist/host-runtime.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/host-runtime.js"
+    },
+    "./host-runtime": "./dist/host-runtime.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "prepublishOnly": "pnpm run build"
+  },
+  "peerDependencies": {
+    "@tanstack/react-query": "^5.90.21",
+    "react": "^19.2.4",
+    "react-dom": "^19.2.4",
+    "react-router-dom": "^7.13.1"
+  },
+  "devDependencies": {
+    "@types/react": "^19.2.14",
+    "@types/react-dom": "^19.2.3",
+    "typescript": "~5.9.3"
+  }
+}