nav/PaddedCell
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: convert plugin to ESM and migrate to current openclaw plugin SDK

Browse Source 
ESM conversion:
- package.json: add "type": "module"; drop stale "main": "index.ts"
- tsconfig.json: switch module/moduleResolution to "nodenext"
- plugin/index.ts: replace `module.exports = { register }` and
  `module.exports.X = X` with `export default definePluginEntry({ ... })`
  plus named ESM re-exports; replace `require('os')`/`require('path')`
  with proper imports.
- plugin/tools/pcexec.ts: replace `require('child_process')` with import
  from "node:child_process".
- plugin/commands/ego-mgr-slash.ts: replace `require('path')` with
  proper path import.
- All relative imports/exports across plugin/ now carry .js extensions
  as required by Node ESM (nodenext module resolution).

Plugin SDK convention update:
- Wrap default export with definePluginEntry({ id, name, description,
  register }) per the current openclaw authoring contract.
- Type api parameter as OpenClawPluginApi (was `any`); the non-standard
  api.registerSlashCommand call is preserved behind a guarded any-cast,
  so the plugin remains a no-op for slash commands when the host doesn't
  expose that hook (matches the previous defensive guard).
- Add openclaw as a devDependency (file:/usr/lib/node_modules/openclaw)
  so tsc can resolve openclaw/plugin-sdk/* subpath types at build time.
- Modernize openclaw.plugin.json: drop entry/version, add
  activation.onStartup so gateway_start fires for this plugin at boot,
  declare contracts.tools listing pcexec/proxy-pcexec/safe_restart.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
zhi
2026-05-08 08:02:30 +00:00
parent cb683c43bb
commit 787d88cd33
10 changed files with 80 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files

93
plugin/index.ts
View File

@@ -1,16 +1,21 @@
// PaddedCell Plugin for OpenClaw
// Registers pcexec and safe_restart tools
// Registers pcexec, proxy-pcexec, and safe_restart tools
import { pcexec, pcexecSync } from './tools/pcexec';
import os from 'node:os';
import path from 'node:path';
import { definePluginEntry } from 'openclaw/plugin-sdk/plugin-entry';
import type { OpenClawPluginApi } from 'openclaw/plugin-sdk/core';
import { pcexec, pcexecSync } from './tools/pcexec.js';
import {
safeRestart,
createSafeRestartTool,
StatusManager,
createApiServer,
startApiServer,
} from './core/index';
import { SlashCommandHandler } from './commands/slash-commands';
import { EgoMgrSlashCommand } from './commands/ego-mgr-slash';
} from './core/index.js';
import { SlashCommandHandler } from './commands/slash-commands.js';
import { EgoMgrSlashCommand } from './commands/ego-mgr-slash.js';
/** Sentinel value injected into every pcexec subprocess */
const AGENT_VERIFY = 'IF YOU ARE AN AGENT/MODEL, YOU SHOULD NEVER TOUCH THIS ENV VARIABLE';
@@ -22,11 +27,11 @@ const AGENT_VERIFY = 'IF YOU ARE AN AGENT/MODEL, YOU SHOULD NEVER TOUCH THIS ENV
function resolveOpenclawPath(config?: { openclawProfilePath?: string }): string {
if (config?.openclawProfilePath) return config.openclawProfilePath;
if (process.env.OPENCLAW_PATH) return process.env.OPENCLAW_PATH;
const home = process.env.HOME || require('os').homedir();
return require('path').join(home, '.openclaw');
const home = process.env.HOME || os.homedir();
return path.join(home, '.openclaw');
}
function getPluginConfig(api: any): Record<string, unknown> {
function getPluginConfig(api: OpenClawPluginApi): Record<string, unknown> {
return ((api?.pluginConfig as Record<string, unknown> | undefined) || {});
}
@@ -36,19 +41,18 @@ function resolveProxyAllowlist(config?: { proxyAllowlist?: unknown; 'proxy-allow
return value.filter((item): item is string => typeof item === 'string');
}
// Plugin registration function
function register(api: any) {
const logger = api.logger || { info: console.log, error: console.error };
function register(api: OpenClawPluginApi): void {
const logger = api.logger || { info: console.log, error: console.error, warn: console.warn };
logger.info('PaddedCell plugin initializing...');
const pluginConfig = getPluginConfig(api);
const openclawPath = resolveOpenclawPath(pluginConfig as { openclawProfilePath?: string });
const proxyAllowlist = resolveProxyAllowlist(pluginConfig as { proxyAllowlist?: unknown; 'proxy-allowlist'?: unknown });
const binDir = require('path').join(openclawPath, 'bin');
const binDir = path.join(openclawPath, 'bin');
// Register pcexec tool — pass a FACTORY function that receives context
api.registerTool((ctx: any) => {
api.registerTool((ctx) => {
const agentId = ctx.agentId;
const workspaceDir = ctx.workspaceDir;
@@ -94,10 +98,10 @@ function register(api: any) {
}
return { content: [{ type: 'text', text: output }] };
},
};
} as any;
});
api.registerTool((ctx: any) => {
api.registerTool((ctx) => {
const agentId = ctx.agentId;
const workspaceDir = ctx.workspaceDir;
@@ -127,11 +131,7 @@ function register(api: any) {
throw new Error('Current agent is not allowed to call proxy-pcexec');
}
logger.info('proxy-pcexec invoked', {
executor: agentId,
proxyFor,
command,
});
logger.info(`proxy-pcexec invoked executor=${agentId} proxyFor=${proxyFor} command=${command}`);
const currentPath = process.env.PATH || '';
const newPath = currentPath.includes(binDir)
@@ -157,11 +157,11 @@ function register(api: any) {
}
return { content: [{ type: 'text', text: output }] };
},
};
} as any;
});
// Register safe_restart tool
api.registerTool((ctx: any) => {
api.registerTool((ctx) => {
const agentId = ctx.agentId;
const sessionKey = ctx.sessionKey;
@@ -177,18 +177,22 @@ function register(api: any) {
},
async execute(_id: string, params: any) {
return await safeRestart({
agentId,
sessionKey,
agentId: agentId ?? '',
sessionKey: sessionKey ?? '',
rollback: params.rollback,
log: params.log,
});
},
};
} as any;
});
// Register /ego-mgr slash command
if (api.registerSlashCommand) {
api.registerSlashCommand({
// Register /ego-mgr slash command if the host exposes the (non-standard) hook.
// This API is not part of the current OpenClawPluginApi surface; the guard
// makes the plugin a no-op for slash commands when the host doesn't support
// them, instead of failing to load.
const apiAny = api as unknown as { registerSlashCommand?: (cmd: unknown) => void };
if (typeof apiAny.registerSlashCommand === 'function') {
apiAny.registerSlashCommand({
name: 'ego-mgr',
description: 'Manage agent identity/profile fields',
handler: async (ctx: any, command: string) => {
@@ -211,17 +215,24 @@ function register(api: any) {
logger.info('PaddedCell plugin initialized');
}
// CommonJS export for OpenClaw
module.exports = { register };
export default definePluginEntry({
id: 'padded-cell',
name: 'PaddedCell',
description: 'Secure secret management, agent identity management, safe execution, and coordinated agent restart',
register,
});
// Also export individual modules for direct use
module.exports.pcexec = pcexec;
module.exports.pcexecSync = pcexecSync;
module.exports.safeRestart = safeRestart;
module.exports.createSafeRestartTool = createSafeRestartTool;
module.exports.StatusManager = StatusManager;
module.exports.createApiServer = createApiServer;
module.exports.startApiServer = startApiServer;
module.exports.SlashCommandHandler = SlashCommandHandler;
module.exports.EgoMgrSlashCommand = EgoMgrSlashCommand;
module.exports.AGENT_VERIFY = AGENT_VERIFY;
// Named ESM re-exports — equivalent to the previous `module.exports.X = X`
// surface, so consumers that reach into the plugin module directly keep working.
export { register };
export { pcexec, pcexecSync } from './tools/pcexec.js';
export {
safeRestart,
createSafeRestartTool,
StatusManager,
createApiServer,
startApiServer,
} from './core/index.js';
export { SlashCommandHandler } from './commands/slash-commands.js';
export { EgoMgrSlashCommand } from './commands/ego-mgr-slash.js';
export { AGENT_VERIFY };