Add IPC types to roo-code.d.ts (#3568)

Author: cte

scripts/generate-types.mts

@@ -1,9 +1,11 @@
-import fs from "fs/promises"
+import path from "path"
+import fs from "fs"
 
 import { zodToTs, createTypeAlias, printNode } from "zod-to-ts"
 import { $ } from "execa"
 
 import schemas from "../src/schemas"
+
 const { typeDefinitions } = schemas
 
 async function main() {
@@ -16,12 +18,16 @@ async function main() {
 		types.push(`export type { ${identifier} }`)
 	}
 
-	await fs.writeFile("src/exports/types.ts", types.join("\n\n"))
+	fs.writeFileSync("src/exports/types.ts", types.join("\n\n"))
 
 	await $`npx tsup src/exports/interface.ts --dts-only -d out`
-	await fs.copyFile('out/interface.d.ts', 'src/exports/roo-code.d.ts')
+	fs.writeFileSync("out/interface.d.ts", "src/exports/roo-code.d.ts")
 
 	await $`npx prettier --write src/exports/types.ts src/exports/roo-code.d.ts`
+
+	if (fs.existsSync(path.join("..", "Roo-Code-Types"))) {
+		fs.copyFileSync("src/exports/roo-code.d.ts", path.join("..", "Roo-Code-Types", "index.d.ts"))
+	}
 }
 
 main()

src/exports/api.ts

@@ -14,7 +14,7 @@ import {
 	ProviderSettingsEntry,
 	isSecretStateKey,
 } from "../schemas"
-import { IpcOrigin, IpcMessageType, TaskCommandName, TaskEvent } from "../schemas/ipc"
+import { IpcOrigin, IpcMessageType, TaskCommandName, TaskEvent } from "../schemas"
 
 import { RooCodeAPI } from "./interface"
 import { IpcServer } from "./ipc"

src/exports/interface.ts

@@ -1,4 +1,9 @@
 import { EventEmitter } from "events"
+import { Socket } from "node:net"
+
+/**
+ * Types
+ */
 
 import type {
 	GlobalSettings,
@@ -7,22 +12,36 @@ import type {
 	ClineMessage,
 	TokenUsage,
 	RooCodeEvents,
+	IpcMessage,
+	TaskCommand,
+	TaskEvent,
 } from "./types"
 
 export type {
-	RooCodeSettings,
 	GlobalSettings,
 	ProviderSettings,
 	ProviderSettingsEntry,
 	ClineMessage,
 	TokenUsage,
 	RooCodeEvents,
+	IpcMessage,
+	TaskCommand,
+	TaskEvent,
 }
 
-import { RooCodeEventName } from "../schemas"
-export type { RooCodeEventName }
+/**
+ * Enums
+ */
+
+import { RooCodeEventName, IpcOrigin, IpcMessageType } from "../schemas"
+
+export { RooCodeEventName, IpcOrigin, IpcMessageType }
+
+/**
+ * RooCodeAPI
+ */
 
-type RooCodeSettings = GlobalSettings & ProviderSettings
+export type RooCodeSettings = GlobalSettings & ProviderSettings
 
 export interface RooCodeAPI extends EventEmitter<RooCodeEvents> {
 	/**
@@ -169,3 +188,26 @@ export interface RooCodeAPI extends EventEmitter<RooCodeEvents> {
 	 */
 	setActiveProfile(name: string): Promise<string | undefined>
 }
+
+/**
+ * RooCodeIpcServer
+ */
+
+export type IpcServerEvents = {
+	[IpcMessageType.Connect]: [clientId: string]
+	[IpcMessageType.Disconnect]: [clientId: string]
+	[IpcMessageType.TaskCommand]: [clientId: string, data: TaskCommand]
+	[IpcMessageType.TaskEvent]: [relayClientId: string | undefined, data: TaskEvent]
+}
+
+export interface RooCodeIpcServer extends EventEmitter<IpcServerEvents> {
+	listen(): void
+
+	broadcast(message: IpcMessage): void
+
+	send(client: string | Socket, message: IpcMessage): void
+
+	get socketPath(): string
+
+	get isListening(): boolean
+}

src/exports/ipc.ts

@@ -4,20 +4,14 @@ import * as crypto from "node:crypto"
 
 import ipc from "node-ipc"
 
-import { IpcOrigin, IpcMessageType, IpcMessage, ipcMessageSchema, TaskCommand, TaskEvent } from "../schemas/ipc"
+import { IpcOrigin, IpcMessageType, type IpcMessage, ipcMessageSchema } from "../schemas"
+import type { IpcServerEvents, RooCodeIpcServer } from "./interface"
 
 /**
  * IpcServer
  */
 
-type IpcServerEvents = {
-	[IpcMessageType.Connect]: [clientId: string]
-	[IpcMessageType.Disconnect]: [clientId: string]
-	[IpcMessageType.TaskCommand]: [clientId: string, data: TaskCommand]
-	[IpcMessageType.TaskEvent]: [relayClientId: string | undefined, data: TaskEvent]
-}
-
-export class IpcServer extends EventEmitter<IpcServerEvents> {
+export class IpcServer extends EventEmitter<IpcServerEvents> implements RooCodeIpcServer {
 	private readonly _socketPath: string
 	private readonly _log: (...args: unknown[]) => void
 	private readonly _clients: Map<string, Socket>