@openkaiden/api 0.2.2 → 0.3.0-next.202606240904-41516c0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openkaiden/api",
-  "version": "0.2.2",
+  "version": "0.3.0-next.202606240904-41516c0",
   "description": "API for Kaiden extensions",
   "repository": "https://github.com/openkaiden/kaiden",
   "publishConfig": {
@@ -12,8 +12,9 @@
   "files": [
     "src"
   ],
-  "devDependencies": {
-    "@ai-sdk/provider": "^3.0.10"
+  "dependencies": {
+    "@ai-sdk/provider": "^3.0.10",
+    "@openkaiden/workspace-configuration": "^0.14.0"
   },
   "scripts": {
     "clean": "rimraf lib *.tsbuildinfo",

package/src/extension-api.d.ts

@@ -42,6 +42,7 @@
 declare module '@openkaiden/api' {
   import type { ProviderV3 as AISDKInferenceProvider } from '@ai-sdk/provider';
   import type { components } from '@openkaiden/mcp-registry-types';
+  import type { components as workspaceConfigComponents } from '@openkaiden/workspace-configuration';
 
   /**
    * The version of Kaiden.
@@ -655,6 +656,7 @@ declare module '@openkaiden/api' {
   }
 
   export type InferenceProviderConnection = {
+    id: string;
     name: string;
     type: InferenceProviderConnectionType;
     llmMetadata?: LLMMetadata;
@@ -713,9 +715,12 @@ declare module '@openkaiden/api' {
     text: Uri;
   };
 
-  export type ChunkProvider = {
+  export type ChunkProviderConnection = {
+    id: string;
     name: string;
     chunk(doc: Uri): Promise<Chunk[]>;
+    status(): ProviderConnectionStatus;
+    lifecycle?: ProviderConnectionLifecycle;
   };
 
   export interface ProviderInferenceConnection {
@@ -728,9 +733,9 @@ declare module '@openkaiden/api' {
     connection: RagProviderConnection;
   }
 
-  export interface ProviderChunkerConnection {
+  export interface ProviderChunkProviderConnection {
     providerId: string;
-    connection: ChunkProvider;
+    connection: ChunkProviderConnection;
   }
 
   export type ProviderConnection =
@@ -739,7 +744,8 @@ declare module '@openkaiden/api' {
     | VmProviderConnection
     | InferenceProviderConnection
     | RagProviderConnection
-    | FlowProviderConnection;
+    | FlowProviderConnection
+    | ChunkProviderConnection;
 
   // common set of options for creating a provider
   export interface ProviderConnectionFactory {
@@ -762,6 +768,7 @@ declare module '@openkaiden/api' {
   // create programmatically a InferenceProviderConnection
   export interface InferenceProviderConnectionFactory extends ProviderConnectionFactory {
     connectionTypes: InferenceProviderConnectionType[];
+    llmMetadata?: LLMMetadata;
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     create(params: { [key: string]: any }, logger?: Logger, token?: CancellationToken): Promise<void>;
   }
@@ -772,6 +779,11 @@ declare module '@openkaiden/api' {
     create(params: { [key: string]: any }, logger?: Logger, token?: CancellationToken): Promise<void>;
   }
 
+  export interface ChunkProviderConnectionFactory extends ProviderConnectionFactory {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    create(params: { [key: string]: any }, logger?: Logger, token?: CancellationToken): Promise<void>;
+  }
+
   // create a kubernetes provider
   export interface KubernetesProviderConnectionFactory extends ProviderConnectionFactory {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -979,6 +991,11 @@ declare module '@openkaiden/api' {
       connectionAuditor?: Auditor,
     ): Disposable;
 
+    setChunkProviderConnectionFactory(
+      chunkProviderConnectionFactory: ChunkProviderConnectionFactory,
+      connectionAuditor?: Auditor,
+    ): Disposable;
+
     registerContainerProviderConnection(connection: ContainerProviderConnection): Disposable;
     registerKubernetesProviderConnection(connection: KubernetesProviderConnection): Disposable;
     registerVmProviderConnection(connection: VmProviderConnection): Disposable;
@@ -987,6 +1004,8 @@ declare module '@openkaiden/api' {
 
     registerFlowProviderConnection(connection: FlowProviderConnection): Disposable;
 
+    registerChunkProviderConnection(connection: ChunkProviderConnection): Disposable;
+
     registerSkill(skill: CreateSkillParams): Disposable;
 
     registerLifecycle(lifecycle: ProviderLifecycle): Disposable;
@@ -1150,11 +1169,18 @@ declare module '@openkaiden/api' {
     providerId: string;
     connection: RagProviderConnection;
   }
-  export interface RegisterChunkerConnectionEvent {
+  export interface RegisterChunkProviderConnectionEvent {
     providerId: string;
+    connection: ChunkProviderConnection;
+  }
+  export interface UpdateChunkProviderConnectionEvent {
+    providerId: string;
+    connection: ChunkProviderConnection;
+    status: ProviderConnectionStatus;
   }
-  export interface UnregisterChunkerConnectionEvent {
+  export interface UnregisterChunkProviderConnectionEvent {
     providerId: string;
+    connection: ChunkProviderConnection;
   }
 
   export interface RegisterFlowConnectionEvent {
@@ -1176,7 +1202,7 @@ declare module '@openkaiden/api' {
   }
 
   export interface ConnectionFactory {
-    type: 'container' | 'kubernetes' | 'vm';
+    type: 'container' | 'kubernetes' | 'vm' | 'inference';
     providerId: string;
   }
 
@@ -5517,7 +5543,65 @@ declare module '@openkaiden/api' {
     constructor(url: string);
   }
 
-  export namespace rag {
-    export function registerChunkProvider(provider: ChunkProvider): Disposable;
+  export type Runtime = 'openshell' | 'podman';
+
+  export interface ModelType {
+    readonly name: string;
+  }
+
+  export interface AcpConfiguration {
+    readonly args: ReadonlyArray<string>;
+  }
+
+  export interface AgentConfigurationBase {
+    readonly path: string;
+    read(): Promise<string>;
+  }
+  export interface AgentConfigurationFile extends AgentConfigurationBase {
+    update(content: string): Promise<void>;
+  }
+
+  export type AgentWorkspaceConfiguration = workspaceConfigComponents['schemas']['WorkspaceConfiguration'];
+
+  export interface AgentWorkspaceContext {
+    readonly model: {
+      readonly llmMetadata?: LLMMetadata;
+      readonly model: InferenceModel;
+      readonly endpoint?: string;
+    };
+    readonly configurationFiles: ReadonlyArray<AgentConfigurationFile>;
+    readonly workspace: AgentWorkspaceConfiguration;
+  }
+
+  export interface Agent {
+    readonly id: string;
+    readonly name: string;
+    readonly description: string;
+    readonly icon?: ProviderImages;
+    readonly tags?: ReadonlyArray<string>;
+    readonly command: string;
+    readonly acp?: AcpConfiguration;
+    readonly configurationFiles: ReadonlyArray<AgentConfigurationBase>;
+    readonly baseImage?: string;
+    /**
+     * If relative path taken as relative to home folder of the sandbox user or
+     * ${HOME}/path1/path2
+     */
+    readonly destinationSkillsFolder: string;
+    isSupportedModelType?(type: ModelType): boolean | Promise<boolean>;
+    isSupportedRuntime?(runtime: Runtime): boolean | Promise<boolean>;
+    preWorkspaceStart(context: AgentWorkspaceContext): Promise<void>;
+  }
+
+  export interface AgentRegisteredEvent {
+    readonly agent: Agent;
+  }
+
+  export interface AgentUnregisteredEvent {
+    readonly id: string;
+  }
+
+  export namespace agents {
+    export function registerAgent(agent: Agent): Disposable;
   }
 }