lightclawbot 1.1.2-beta.0 → 1.2.0-beta.0

package/README.md

@@ -69,7 +69,6 @@ src/
 ├── download-tool.ts    # AI 工具：下载/获取文件 URL
 ├── dedup.ts            # 消息去重与防抖
 ├── media.ts            # 媒体工具函数
-├── format-urls.ts      # 文件 URL 自动转 Markdown 链接
 ├── types.ts            # 类型定义
 └── history/            # 历史消息读取
 ```

package/dist/index.js

@@ -1,34 +1,41 @@
-import { emptyPluginConfigSchema } from "openclaw/plugin-sdk/core";
-import { myAssistantPlugin } from "./src/channel.js";
-import { setAssistantRuntime } from "./src/runtime.js";
-import { registerUploadTool } from "./src/upload-tool.js";
-// import { registerDownloadTool } from "./src/download-tool.js";
-const plugin = {
+/**
+ * LightClaw — 主入口文件
+ *
+ * 使用 OpenClaw SDK 标准的 defineChannelPluginEntry 工厂函数替代手动创建 plugin 对象，
+ * 遵循 Discord/Slack 等官方 channel 插件的标准 index.ts 模式。
+ *
+ * 该文件定义了 LightClawBot channel plugin 的入口配置，包括插件ID、名称、描述、
+ * 核心插件实现、运行时设置和工具注册等功能。
+ */
+// 导入 OpenClaw SDK 的核心功能
+import { defineChannelPluginEntry } from "openclaw/plugin-sdk/core";
+// 导入本地模块
+import { lightclawPlugin } from "./src/channel.js"; // 核心插件实现
+import { setLightclawRuntime } from "./src/runtime.js"; // 运行时配置设置函数
+import { registerLightclawTools } from "./src/tools.js"; // 工具注册函数
+// 导出运行时设置函数，供外部使用
+export { setLightclawRuntime } from "./src/runtime.js";
+/**
+ * 创建并配置 LightClawBot channel plugin 入口
+ *
+ * 使用 defineChannelPluginEntry 工厂函数创建插件配置对象，
+ * 该函数返回一个类型安全的插件入口配置。
+ *
+ * @type {ReturnType<typeof defineChannelPluginEntry<ChannelPlugin>>}
+ */
+const entry = defineChannelPluginEntry({
+    // 插件唯一标识符，用于在系统中识别该插件
     id: "lightclawbot",
+    // 插件显示名称，在UI中展示给用户
     name: "LightClawBot",
+    // 插件功能描述，说明插件的主要用途
     description: "Channel plugin for LightClawBot",
-    configSchema: emptyPluginConfigSchema(),
-    register(api) {
-        setAssistantRuntime(api.runtime);
-        api.registerChannel({ plugin: myAssistantPlugin });
-        // 注册文件存储工具（飞书工厂函数模式：execute 时动态从 api.config 解析 apiKey）
-        registerUploadTool(api);
-        // registerDownloadTool(api);
-    },
-};
-export default plugin;
-export { myAssistantPlugin } from "./src/channel.js";
-export { setAssistantRuntime, getAssistantRuntime } from "./src/runtime.js";
-export * from "./src/types.js";
-export * from "./src/config.js";
-export * from "./src/gateway.js";
-export * from "./src/dedup.js";
-export * from "./src/media.js";
-export * from "./src/inbound.js";
-export * from "./src/socket/index.js";
-export * from "./src/outbound.js";
-export * from "./src/history/index.js";
-export * from "./src/file-storage.js";
-export * from "./src/upload-tool.js";
-export * from "./src/download-tool.js";
-//# sourceMappingURL=index.js.map
+    // 核心插件实现，包含消息处理、事件响应等核心逻辑
+    plugin: lightclawPlugin,
+    // 运行时设置函数，用于配置插件运行时的环境和参数
+    setRuntime: setLightclawRuntime,
+    // 完整工具注册函数，用于向系统注册插件提供的所有工具和能力
+    registerFull: registerLightclawTools,
+});
+// 导出默认入口配置，供 OpenClaw SDK 加载和使用
+export default entry;

package/dist/setup-entry.js

@@ -0,0 +1,32 @@
+/**
+ * LightClaw — Setup 入口文件
+ *
+ * 使用 OpenClaw SDK 提供的 defineSetupPluginEntry 工厂函数导出轻量级的 setup 插件配置。
+ *
+ * 该入口文件的主要作用是：
+ * - 当插件未配置或未启用时，OpenClaw 系统只会加载此轻量级入口
+ * - 避免拉起 ws 等运行时重依赖，减少系统启动开销
+ * - 提供插件的基本信息和配置能力，但不包含完整的运行时逻辑
+ *
+ * 这种设计模式有助于：
+ * - 降低系统启动时的内存占用
+ * - 提高插件加载性能
+ * - 支持按需加载插件功能
+ */
+// 导入 OpenClaw SDK 的 setup 插件入口定义函数
+import { defineSetupPluginEntry } from "openclaw/plugin-sdk/core";
+// 导入本地的 setup 插件实现
+import { lightclawSetupPlugin } from "./src/channel.setup.js";
+// 导出 setup 插件实现，供外部模块使用或测试
+export { lightclawSetupPlugin } from "./src/channel.setup.js";
+/**
+ * 默认导出 setup 插件入口配置
+ *
+ * 使用 defineSetupPluginEntry 工厂函数创建并配置 setup 插件：
+ * - 包装 lightclawSetupPlugin 实例
+ * - 提供标准的插件入口接口
+ * - 确保插件符合 OpenClaw SDK 的规范要求
+ *
+ * @returns {ReturnType<typeof defineSetupPluginEntry>} 配置完成的 setup 插件入口
+ */
+export default defineSetupPluginEntry(lightclawSetupPlugin);