@2en/clawly-plugins 1.24.2 → 1.24.3

package/types.ts

@@ -0,0 +1,131 @@
+// ---------------------------------------------------------------------------
+// Types aligned with OpenClaw plugin API (openclaw/src/plugins/types.ts)
+// ---------------------------------------------------------------------------
+
+import type {OpenClawConfig} from './types/openclaw'
+
+export type PluginLogger = {
+  debug?: (message: string) => void
+  info: (message: string) => void
+  warn: (message: string) => void
+  error: (message: string) => void
+}
+
+export type PluginRuntime = {
+  version?: string
+  config?: {
+    loadConfig?: (...args: unknown[]) => unknown
+    writeConfigFile?: (...args: unknown[]) => unknown
+  }
+  system?: {
+    runCommandWithTimeout?: (
+      argv: string[],
+      opts: {timeoutMs: number; cwd?: string; env?: Record<string, string | undefined>},
+    ) => Promise<{
+      stdout: string
+      stderr: string
+      code: number | null
+      signal: string | null
+      killed: boolean
+    }>
+  }
+  state?: {
+    resolveStateDir?: (env?: NodeJS.ProcessEnv) => string
+  }
+}
+
+export type GatewayRequestHandler = (opts: {
+  params: Record<string, unknown>
+  respond: (ok: boolean, payload?: unknown, error?: {code?: string; message?: string}) => void
+}) => Promise<void> | void
+
+export type PluginHookName =
+  | 'before_agent_start'
+  | 'agent_end'
+  | 'before_compaction'
+  | 'after_compaction'
+  | 'before_reset'
+  | 'message_received'
+  | 'message_sending'
+  | 'message_sent'
+  | 'before_tool_call'
+  | 'after_tool_call'
+  | 'tool_result_persist'
+  | 'session_start'
+  | 'session_end'
+  | 'gateway_start'
+  | 'gateway_stop'
+
+export type PluginApi = {
+  /** id from openclaw.plugin.json */
+  id: string
+  /** name from openclaw.plugin.json */
+  name: string
+  /** version from openclaw.plugin.json */
+  version?: string
+  /** description from openclaw.plugin.json */
+  description?: string
+  source?: string
+  config?: OpenClawConfig
+  pluginConfig?: Record<string, unknown>
+  runtime: PluginRuntime
+  logger: PluginLogger
+  registerGatewayMethod: (method: string, handler: GatewayRequestHandler) => void
+  registerTool: (
+    tool: {
+      name: string
+      description: string
+      parameters: Record<string, unknown>
+      execute: (
+        toolCallId: string,
+        params: Record<string, unknown>,
+      ) => Promise<{content: Array<{type: string; text: string}>; details?: unknown}>
+    },
+    opts?: {optional?: boolean},
+  ) => void
+  registerHook?: (
+    events: string | string[],
+    handler: (...args: unknown[]) => unknown,
+    opts?: {name?: string; description?: string; register?: boolean},
+  ) => void
+  registerCommand: (cmd: {
+    name: string
+    description?: string
+    acceptsArgs?: boolean
+    requireAuth?: boolean
+    handler: (ctx: {
+      args?: string
+      [key: string]: unknown
+    }) => Promise<{text: string}> | {text: string}
+  }) => void
+  registerChannel: (registration: {plugin: unknown; dock?: unknown}) => void
+  registerHttpHandler?: (
+    handler: (
+      req: import('node:http').IncomingMessage,
+      res: import('node:http').ServerResponse,
+    ) => Promise<boolean> | boolean,
+  ) => void
+  registerHttpRoute: (params: {
+    path: string
+    handler: (
+      req: import('node:http').IncomingMessage,
+      res: import('node:http').ServerResponse,
+    ) => Promise<void> | void
+  }) => void
+  registerCli?: (
+    registrar: (...args: unknown[]) => void | Promise<void>,
+    opts?: {commands?: string[]},
+  ) => void
+  registerService?: (service: {
+    id: string
+    start: (...args: unknown[]) => void | Promise<void>
+    stop?: (...args: unknown[]) => void | Promise<void>
+  }) => void
+  registerProvider?: (provider: Record<string, unknown>) => void
+  resolvePath?: (input: string) => string
+  on: (
+    hookName: PluginHookName | (string & {}),
+    handler: (...args: any[]) => any,
+    opts?: {priority?: number},
+  ) => void
+}