@xgjktech/xg-openclaw-harness-tools 0.3.2 → 0.3.5

package/dist/action-dispatch-tool.d.ts

@@ -0,0 +1,15 @@
+import { Type, type Static } from "typebox";
+import type { AnyAgentTool } from "openclaw/plugin-sdk/plugin-entry";
+import { type ActionStore, type PlanOrigin } from "@xgjktech/xg-openclaw-shared";
+export declare const ActionDispatchParams: Type.TObject<{
+    action: Type.TUnion<[Type.TLiteral<"ui_refresh">, Type.TLiteral<"notification">, Type.TLiteral<"workflow_trigger">, Type.TLiteral<"form_fill">, Type.TString]>;
+    target: Type.TString;
+    topic: Type.TOptional<Type.TString>;
+    status: Type.TOptional<Type.TUnion<[Type.TLiteral<"completed">, Type.TLiteral<"running">, Type.TLiteral<"pending">, Type.TLiteral<"failed">]>>;
+    activeSessionOnly: Type.TOptional<Type.TBoolean>;
+    payloadData: Type.TRecord<"^.*$", Type.TUnknown>;
+}>;
+export type ActionDispatchParamsT = Static<typeof ActionDispatchParams>;
+export declare const ACTION_DISPATCH_DESCRIPTION: string;
+export declare function buildActionDispatchTool(store: ActionStore, origin?: PlanOrigin): AnyAgentTool;
+//# sourceMappingURL=action-dispatch-tool.d.ts.map

package/dist/action-dispatch-tool.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"action-dispatch-tool.d.ts","sourceRoot":"","sources":["../src/action-dispatch-tool.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,KAAK,MAAM,EAAE,MAAM,SAAS,CAAC;AAC5C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAIL,KAAK,WAAW,EAChB,KAAK,UAAU,EAChB,MAAM,8BAA8B,CAAC;AAGtC,eAAO,MAAM,oBAAoB;;;;;;;EA+ChC,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAExE,eAAO,MAAM,2BAA2B,QAS5B,CAAC;AAMb,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,WAAW,EAAE,MAAM,CAAC,EAAE,UAAU,GAAG,YAAY,CA0D7F"}

package/dist/action-dispatch-tool.js

@@ -0,0 +1,96 @@
+import { randomUUID } from "node:crypto";
+import { Type } from "typebox";
+import { assertActionDispatchEventInvariants, } from "@xgjktech/xg-openclaw-shared";
+import { toolJsonResult } from "./tool-json-result.js";
+export const ActionDispatchParams = Type.Object({
+    action: Type.Union([
+        Type.Literal("ui_refresh"),
+        Type.Literal("notification"),
+        Type.Literal("workflow_trigger"),
+        Type.Literal("form_fill"),
+        Type.String({ description: "自定义扩展动作类型" }),
+    ], { description: "指令动作大类" }),
+    target: Type.String({
+        minLength: 1,
+        maxLength: 128,
+        description: "目标组件或页面标识 (必须严格等于前端注册的 target 标识，如 order_detail_panel)",
+    }),
+    topic: Type.Optional(Type.String({
+        maxLength: 64,
+        description: "业务主题/模块标识 (如 order_management, user_system)",
+    })),
+    status: Type.Optional(Type.Union([
+        Type.Literal("completed"),
+        Type.Literal("running"),
+        Type.Literal("pending"),
+        Type.Literal("failed"),
+    ], { default: "completed", description: "动作生命周期状态" })),
+    activeSessionOnly: Type.Optional(Type.Boolean({ default: true, description: "是否限制仅在当前激活前端窗口生效" })),
+    payloadData: Type.Record(Type.String(), Type.Unknown(), {
+        description: "传递给前端的具体业务数据键值对 (格式为 { data: { ... } })",
+    }),
+}, { additionalProperties: false });
+export const ACTION_DISPATCH_DESCRIPTION = [
+    "用途：分发通用动作指令（如 UI 局部刷新 ui_refresh、通知 notification、工作流触发 workflow_trigger、表单填充 form_fill 等）给前端客户端消费。",
+    "",
+    "参数要求：",
+    "- action: 动作类型枚举 (ui_refresh, notification, workflow_trigger, form_fill 或自定义扩展动作)。",
+    "- target: 目标组件或页面标识 (如 order_detail_panel)。",
+    "- payloadData: 包含要传递给前端业务数据的键值字典。",
+    "- activeSessionOnly: 默认为 true，限制仅在活跃前端窗口生效。",
+    "- status: 默认为 completed，异步长任务可用 running/pending/failed 表达状态变化。",
+].join("\n");
+export function buildActionDispatchTool(store, origin) {
+    return {
+        name: "xg_action_dispatch",
+        label: "【xg-harness】动作指令分发",
+        description: ACTION_DISPATCH_DESCRIPTION,
+        parameters: ActionDispatchParams,
+        async execute(_toolCallId, rawParams) {
+            const params = rawParams;
+            try {
+                const eventId = `evt_${randomUUID()}`;
+                const now = new Date();
+                const version = now.getTime();
+                const status = params.status ?? "completed";
+                const event = {
+                    eventId,
+                    event: "action_dispatch",
+                    action: params.action,
+                    target: params.target,
+                    version,
+                    status,
+                    scopeControl: {
+                        activeSessionOnly: params.activeSessionOnly ?? true,
+                    },
+                    payload: {
+                        data: params.payloadData,
+                    },
+                    timestamp: now.toISOString(),
+                };
+                if (params.topic !== undefined && params.topic.trim() !== "") {
+                    event.topic = params.topic;
+                }
+                if (origin !== undefined) {
+                    event.origin = origin;
+                }
+                assertActionDispatchEventInvariants(event);
+                store.set(event);
+                const result = {
+                    ok: true,
+                    eventId: event.eventId,
+                    version: event.version,
+                    event,
+                };
+                return toolJsonResult(result);
+            }
+            catch (e) {
+                const result = {
+                    ok: false,
+                    error: { code: "ACTION_DISPATCH_ERROR", detail: String(e.message) },
+                };
+                return toolJsonResult(result);
+            }
+        },
+    };
+}

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAYA,wBAoCG"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAiBA,wBAqDG"}

package/dist/index.js

@@ -1,23 +1,30 @@
 import { defineToolPlugin } from "openclaw/plugin-sdk/tool-plugin";
-import { resolvePlanDbPath, SqlitePlanStore } from "@xgjktech/xg-openclaw-shared";
+import { resolvePlanDbPath, SqlitePlanStore, SqliteActionStore } from "@xgjktech/xg-openclaw-shared";
 import { PLAN_WRITE_DESCRIPTION, PlanWriteParams, buildPlanWriteTool } from "./plan-write-tool.js";
 import { PLAN_EXECUTE_DESCRIPTION, PlanExecuteParams, buildPlanExecuteTool, } from "./plan-execute-tool.js";
+import { ACTION_DISPATCH_DESCRIPTION, ActionDispatchParams, buildActionDispatchTool, } from "./action-dispatch-tool.js";
 import { toPlanOrigin } from "./plan-origin.js";
 const PLUGIN_ID = "xg-harness-tools";
 export default defineToolPlugin({
     id: PLUGIN_ID,
     name: "XG Harness Tools",
-    description: "企业工具插件：计划编写与查看（plan_write / plan_execute）",
+    description: "企业工具插件：计划管理与通用动作分发（plan_write / plan_execute / action_dispatch）",
     tools: (tool) => {
-        // store 单例：defineToolPlugin 的 tools(...) 只在插件加载时调用一次，
-        // 闭包在此建一次即可；factory 本身会在每次 agent attempt 重建工具集时重新调用。
-        let store;
-        const getStore = (api) => {
-            if (store === undefined) {
+        let planStore;
+        let actionStore;
+        const getPlanStore = (api) => {
+            if (planStore === undefined) {
                 const dbPath = resolvePlanDbPath(api.runtime.state.resolveStateDir());
-                store = new SqlitePlanStore(dbPath);
+                planStore = new SqlitePlanStore(dbPath);
             }
-            return store;
+            return planStore;
+        };
+        const getActionStore = (api) => {
+            if (actionStore === undefined) {
+                const dbPath = resolvePlanDbPath(api.runtime.state.resolveStateDir());
+                actionStore = new SqliteActionStore(dbPath);
+            }
+            return actionStore;
         };
         return [
             tool({
@@ -26,7 +33,7 @@ export default defineToolPlugin({
                 description: PLAN_WRITE_DESCRIPTION,
                 parameters: PlanWriteParams,
                 optional: true,
-                factory: ({ api, toolContext }) => buildPlanWriteTool(getStore(api), toPlanOrigin(toolContext)),
+                factory: ({ api, toolContext }) => buildPlanWriteTool(getPlanStore(api), toPlanOrigin(toolContext)),
             }),
             tool({
                 name: "xg_plan_execute",
@@ -34,7 +41,15 @@ export default defineToolPlugin({
                 description: PLAN_EXECUTE_DESCRIPTION,
                 parameters: PlanExecuteParams,
                 optional: true,
-                factory: ({ api, toolContext }) => buildPlanExecuteTool({ store: getStore(api), origin: toPlanOrigin(toolContext) }),
+                factory: ({ api, toolContext }) => buildPlanExecuteTool({ store: getPlanStore(api), origin: toPlanOrigin(toolContext) }),
+            }),
+            tool({
+                name: "xg_action_dispatch",
+                label: "【xg-harness】动作指令分发",
+                description: ACTION_DISPATCH_DESCRIPTION,
+                parameters: ActionDispatchParams,
+                optional: true,
+                factory: ({ api, toolContext }) => buildActionDispatchTool(getActionStore(api), toPlanOrigin(toolContext)),
             }),
         ];
     },

package/openclaw.plugin.json

@@ -1,7 +1,7 @@
 {
   "id": "xg-harness-tools",
   "name": "XG Harness Tools",
-  "description": "企业计划工具（plan_write / plan_execute）",
+  "description": "企业工具插件：计划管理与通用动作分发（plan_write / plan_execute / action_dispatch）",
   "version": "0.1.0",
   "configSchema": {
     "type": "object",
@@ -9,6 +9,6 @@
     "properties": {}
   },
   "contracts": {
-    "tools": ["xg_plan_write", "xg_plan_execute"]
+    "tools": ["xg_plan_write", "xg_plan_execute", "xg_action_dispatch"]
   }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@xgjktech/xg-openclaw-harness-tools",
-  "version": "0.3.2",
-  "description": "企业工具插件：plan_write / plan_execute 计划工具（OpenClaw 第三方工具插件）",
+  "version": "0.3.5",
+  "description": "企业工具插件：plan_write / plan_execute / action_dispatch（OpenClaw 第三方工具插件）",
   "license": "MIT",
   "type": "module",
   "engines": {
@@ -52,4 +52,4 @@
       "defaultChoice": "local"
     }
   }
-}
+}