@thclouds/openclaw-channel-taidesk 0.1.0 → 0.1.2

package/README.md

@@ -1,6 +1,6 @@
 # openclaw-channel-taidesk
 
-OpenClaw 渠道插件：**Taidesk MQTT 入站**（订阅 `/open/{agentId}`）+ **HTTP 出站**。
+OpenClaw 渠道插件：**Taidesk MQTT 入站**（订阅 **`/open` + agentId**，中间无 `/`）+ **HTTP 出站**。
 
 ## 文档
 
@@ -35,7 +35,7 @@ OpenClaw 渠道插件：**Taidesk MQTT 入站**（订阅 `/open/{agentId}`）+ *
 }
 ```
 
-订阅 topic：**`/open/{agentId}`**。入站 JSON 见契约文档中的 `agent_msg` 示例。
+订阅 topic：**`/open` + `agentId`**（例：`agentId` 为 `2014147198056767490` 时 topic 为 `/open2014147198056767490`）。入站 JSON 见契约文档中的 `agent_msg` 示例。
 
 ## 脚本
 

package/index.ts

@@ -1,14 +1,30 @@
-import { defineChannelPluginEntry } from "openclaw/plugin-sdk/core";
+import type { OpenClawPluginApi } from "openclaw/plugin-sdk/plugin-entry";
+import { buildChannelConfigSchema } from "openclaw/plugin-sdk/channel-config-schema";
 
 import { taideskPlugin } from "./src/channel.js";
+import { assertHostCompatibility } from "./src/compat.js";
+import { TaideskChannelConfigSchema } from "./src/config/config-schema.js";
 import { setTaideskRuntime } from "./src/runtime.js";
 
 export { taideskPlugin, setTaideskRuntime };
 
-export default defineChannelPluginEntry({
+export default {
   id: "taidesk",
-  name: "Taidesk Channel",
-  description: "Taidesk WebSocket inbound + HTTP outbound",
-  plugin: taideskPlugin,
-  setRuntime: setTaideskRuntime,
-});
+  name: "Taidesk",
+  description: "Taidesk channel (MQTT inbound + HTTP webhook outbound)",
+  configSchema: buildChannelConfigSchema(TaideskChannelConfigSchema),
+  register(api: OpenClawPluginApi) {
+    // Fail-fast: reject incompatible host versions before any side-effects.
+    assertHostCompatibility(api.runtime?.version);
+
+    if (api.runtime) {
+      setTaideskRuntime(api.runtime);
+    }
+
+    api.registerChannel({ plugin: taideskPlugin });
+
+    // registrationMode exists in 2026.3.22+; skip heavy registrations in setup-only mode.
+    const mode = (api as { registrationMode?: string }).registrationMode;
+    if (mode && mode !== "full") return;
+  },
+};

package/openclaw.plugin.json

@@ -1,6 +1,9 @@
 {
   "id": "taidesk",
-  "name": "Taidesk Channel",
-  "description": "Taidesk WebSocket inbound + HTTP outbound",
-  "extensions": ["./index.ts"]
+  "channels": ["taidesk"],
+  "configSchema": {
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {}
+  }
 }

package/package.json

@@ -1,20 +1,23 @@
 {
   "name": "@thclouds/openclaw-channel-taidesk",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "OpenClaw Taidesk channel plugin (MQTT inbound + HTTP outbound)",
   "license": "MIT",
+  "author": "thclouds",
   "type": "module",
-  "main": "index.ts",
   "files": [
+    "src/",
+    "!src/**/*.test.ts",
+    "!src/**/node_modules/",
     "index.ts",
-    "setup-entry.ts",
-    "src/**/*.ts",
-    "openclaw.plugin.json"
+    "openclaw.plugin.json",
+    "README.md"
   ],
   "scripts": {
     "type-check": "tsc -p tsconfig.json --noEmit",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
     "test": "vitest run",
-    "prepublishOnly": "npm run type-check && npm test"
+    "prepublishOnly": "npm run typecheck && npm test"
   },
   "publishConfig": {
     "access": "public",

package/src/api/{taidesk-outbound.ts → api.ts}

@@ -1,6 +1,6 @@
 import type { OpenClawConfig } from "openclaw/plugin-sdk/core";
 
-import { resolveTaideskAccount } from "../config.js";
+import { resolveTaideskAccount } from "../config/config.js";
 import type { TaideskAccountConfig } from "../types.js";
 
 function resolveTaideskWebhookUrl(config: TaideskAccountConfig): string {

package/src/channel.ts

@@ -2,16 +2,14 @@ import { randomUUID } from "node:crypto";
 
 import type { ChannelGatewayContext, ChannelPlugin } from "openclaw/plugin-sdk";
 import type { OpenClawConfig } from "openclaw/plugin-sdk/core";
-import { buildChannelConfigSchema } from "openclaw/plugin-sdk/core";
 
-import { TaideskChannelConfigSchema } from "./config-schema.js";
 import {
   applyTaideskAccountDefaults,
   getTaideskConfig,
   isTaideskAccountConfigured,
-} from "./config.js";
-import { startTaideskMonitor } from "./monitor/taidesk-monitor.js";
-import { sendTaideskText } from "./api/taidesk-outbound.js";
+} from "./config/config.js";
+import { sendTaideskText } from "./api/api.js";
+import { monitorTaideskProvider } from "./monitor/monitor.js";
 import type { TaideskAccountConfig } from "./types.js";
 
 export type ResolvedTaideskAccount = {
@@ -40,9 +38,17 @@ export const taideskPlugin: ChannelPlugin<ResolvedTaideskAccount> = {
     label: "Taidesk",
     selectionLabel: "Taidesk (MQTT)",
     docsPath: "/channels/taidesk",
-    blurb: "Taidesk：MQTT 入站 `/open/{agentId}` + HTTP 出站",
+    docsLabel: "Taidesk",
+    blurb: "Taidesk：MQTT 入站 `/open`+agentId + HTTP 出站",
+    order: 76,
+  },
+  configSchema: {
+    schema: {
+      type: "object",
+      additionalProperties: false,
+      properties: {},
+    },
   },
-  configSchema: buildChannelConfigSchema(TaideskChannelConfigSchema),
   reload: { configPrefixes: ["channels.taidesk"] },
   capabilities: {
     chatTypes: ["direct"],
@@ -145,7 +151,7 @@ export const taideskPlugin: ChannelPlugin<ResolvedTaideskAccount> = {
       if (!isTaideskAccountConfigured(account.config)) {
         throw new Error("taidesk: mqttUrl、agentId、webhook、apiKey 为必填（且需替换默认占位 agentId/apiKey）");
       }
-      const mon = startTaideskMonitor({
+      const mon = monitorTaideskProvider({
         cfg,
         accountId: account.accountId,
         accountConfig: account.config,

package/src/compat.ts

@@ -0,0 +1,94 @@
+/**
+ * Runtime host-version compatibility check for openclaw-channel-taidesk.
+ *
+ * OpenClaw uses a date-based version format: YYYY.M.DD (e.g. 2026.3.22).
+ * This module parses that format and validates the running host is within
+ * the supported range for this plugin version.
+ */
+
+import fs from "node:fs";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+
+import { logger } from "./util/logger.js";
+
+function readPluginVersion(): string {
+  try {
+    const dir = path.dirname(fileURLToPath(import.meta.url));
+    const pkgPath = path.resolve(dir, "..", "package.json");
+    const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf-8")) as { version?: string };
+    return pkg.version ?? "unknown";
+  } catch {
+    return "unknown";
+  }
+}
+
+/** Package version (from package.json); single source of truth with npm publish. */
+export const PLUGIN_VERSION = readPluginVersion();
+
+export const SUPPORTED_HOST_MIN = "2026.3.22";
+
+export interface OpenClawVersion {
+  year: number;
+  month: number;
+  day: number;
+}
+
+/**
+ * Parse an OpenClaw date version string (e.g. "2026.3.22") into components.
+ * Returns null for unparseable strings.
+ */
+export function parseOpenClawVersion(version: string): OpenClawVersion | null {
+  // Strip any pre-release suffix (e.g. "2026.3.22-beta.1" -> "2026.3.22")
+  const base = version.trim().split("-")[0];
+  const parts = base.split(".");
+  if (parts.length !== 3) return null;
+  const [year, month, day] = parts.map(Number);
+  if (Number.isNaN(year) || Number.isNaN(month) || Number.isNaN(day)) return null;
+  return { year, month, day };
+}
+
+/**
+ * Compare two parsed versions.  Returns -1 | 0 | 1.
+ */
+export function compareVersions(a: OpenClawVersion, b: OpenClawVersion): -1 | 0 | 1 {
+  for (const key of ["year", "month", "day"] as const) {
+    if (a[key] < b[key]) return -1;
+    if (a[key] > b[key]) return 1;
+  }
+  return 0;
+}
+
+/**
+ * Check whether a host version string is >= SUPPORTED_HOST_MIN.
+ */
+export function isHostVersionSupported(hostVersion: string): boolean {
+  const host = parseOpenClawVersion(hostVersion);
+  if (!host) return false;
+  const min = parseOpenClawVersion(SUPPORTED_HOST_MIN)!;
+  return compareVersions(host, min) >= 0;
+}
+
+/**
+ * Fail-fast guard.  Call at the very start of `register()` to prevent the
+ * plugin from loading on an incompatible host.
+ *
+ * @throws {Error} with a human-readable message when the host is out of range.
+ */
+export function assertHostCompatibility(hostVersion: string | undefined): void {
+  if (!hostVersion || hostVersion === "unknown") {
+    logger.warn(
+      `[compat] Could not determine host OpenClaw version; skipping compatibility check.`,
+    );
+    return;
+  }
+  if (isHostVersionSupported(hostVersion)) {
+    logger.info(`[compat] Host OpenClaw ${hostVersion} >= ${SUPPORTED_HOST_MIN}, OK.`);
+    return;
+  }
+  throw new Error(
+    `@thclouds/openclaw-channel-taidesk@${PLUGIN_VERSION} requires OpenClaw >=${SUPPORTED_HOST_MIN}, ` +
+      `but found ${hostVersion}. ` +
+      `Please upgrade OpenClaw.`,
+  );
+}

package/src/{config.ts → config/config.ts}

@@ -1,7 +1,7 @@
 import type { OpenClawConfig } from "openclaw/plugin-sdk/core";
 
 import { TAIDESK_ACCOUNT_DEFAULTS } from "./config-schema.js";
-import type { TaideskAccountConfig } from "./types.js";
+import type { TaideskAccountConfig } from "../types.js";
 
 export function getTaideskSection(cfg: OpenClawConfig): Record<string, unknown> {
   const ch = cfg.channels as Record<string, unknown> | undefined;

package/src/messaging/{process-inbound.ts → process-message.ts}

@@ -3,7 +3,7 @@ import type { PluginRuntime } from "openclaw/plugin-sdk/core";
 import { createTypingCallbacks } from "openclaw/plugin-sdk/channel-runtime";
 import type { MsgContext } from "openclaw/plugin-sdk/reply-runtime";
 
-import { sendTaideskText } from "../api/taidesk-outbound.js";
+import { sendTaideskText } from "../api/api.js";
 import type { TaideskInboundEvent } from "../types.js";
 
 export async function processTaideskInbound(params: {

package/src/monitor/{taidesk-monitor.ts → monitor.ts}

@@ -4,7 +4,7 @@ import type { PluginRuntime } from "openclaw/plugin-sdk/core";
 import { shouldSkipDedup } from "../dedup.js";
 import { parseTaideskInboundJson } from "../inbound-handler.js";
 import { createTaideskMqttConnection } from "../mqtt/taidesk-mqtt-client.js";
-import { processTaideskInbound } from "../messaging/process-inbound.js";
+import { processTaideskInbound } from "../messaging/process-message.js";
 import { resolveTaideskChannelRuntime } from "../runtime.js";
 import type { TaideskAccountConfig } from "../types.js";
 
@@ -19,9 +19,9 @@ export type MonitorTaideskOpts = {
 };
 
 /**
- * 替代微信 `monitorWeixinProvider`：MQTT 订阅 `/open/{agentId}` → 单条处理。
+ * Taidesk 入站：MQTT 订阅 `/open`+agentId → 单条处理（对应微信 `monitorWeixinProvider`）。
  */
-export function startTaideskMonitor(opts: MonitorTaideskOpts): { close: () => void } {
+export function monitorTaideskProvider(opts: MonitorTaideskOpts): { close: () => void } {
   const log = opts.log ?? (() => {});
   const errLog = opts.errLog ?? log;
   const pwd = opts.accountConfig.mqttPassword ?? opts.accountConfig.apiKey ?? opts.accountConfig.token;
@@ -35,7 +35,7 @@ export function startTaideskMonitor(opts: MonitorTaideskOpts): { close: () => vo
     abortSignal: opts.abortSignal,
     onConnect: () => {
       log(
-        `taidesk mqtt connected account=${opts.accountId} topic=/open/${opts.accountConfig.agentId}`,
+        `taidesk mqtt connected account=${opts.accountId} topic=/open${opts.accountConfig.agentId}`,
       );
     },
     onMessage: (_topic, raw) => {

package/src/mqtt/taidesk-mqtt-client.ts

@@ -14,7 +14,7 @@ export function normalizeMqttConnectUrl(mqttUrl: string): string {
 export type TaideskMqttClientOptions = {
   /** 例如 mqtt://、mqtts://、ws://、wss://（MQTT over WebSocket）；https/http 会规范为 wss/ws */
   mqttUrl: string;
-  /** 订阅 topic：`/open/{agentId}` */
+  /** 订阅 topic：`/open` + agentId（与 Taidesk Broker 一致，中间无 `/`） */
   agentId: string;
   mqttUsername?: string;
   mqttPassword?: string;
@@ -27,11 +27,11 @@ export type TaideskMqttClientOptions = {
 };
 
 /**
- * Taidesk 入站：MQTT 订阅 `/open/{agentId}`。
+ * Taidesk 入站：MQTT 订阅 `/open` + agentId（示例：`/open2014147198056767490`）。
  * 重连由 mqtt.js 内置 `reconnectPeriod` 处理。
  */
 export function createTaideskMqttConnection(opts: TaideskMqttClientOptions): { close: () => void } {
-  const topic = `/open/${opts.agentId}`;
+  const topic = `/open${opts.agentId.trim()}`;
   const connectUrl = normalizeMqttConnectUrl(opts.mqttUrl);
   const client = mqtt.connect(connectUrl, {
     username: opts.mqttUsername,

package/src/types.ts

@@ -16,7 +16,7 @@ export type TaideskAccountConfig = {
   name?: string;
   /** MQTT Broker，如 mqtts://host:8883、wss://host/mqtt；https:// 会在连接前规范为 wss:// */
   mqttUrl: string;
-  /** 订阅 topic `/open/{agentId}` */
+  /** 订阅 topic 为 `/open` + 本字段（无中间斜杠，如 `/open2014147198056767490`） */
   agentId: string;
   /** 出站 Webhook 完整 URL；可用 `{id}` 占位，发送前替换为 agentId */
   webhook: string;

package/src/util/logger.ts

@@ -0,0 +1,145 @@
+import fs from "node:fs";
+import os from "node:os";
+import path from "node:path";
+
+import { resolvePreferredOpenClawTmpDir } from "openclaw/plugin-sdk/infra-runtime";
+
+/**
+ * Plugin logger — writes JSON lines to the main openclaw log file:
+ *   <tmpDir>/openclaw-YYYY-MM-DD.log
+ * Same file and format used by all other channels.
+ */
+
+const MAIN_LOG_DIR = resolvePreferredOpenClawTmpDir();
+const SUBSYSTEM = "gateway/channels/taidesk";
+const RUNTIME = "node";
+const RUNTIME_VERSION = process.versions.node;
+const HOSTNAME = os.hostname() || "unknown";
+const PARENT_NAMES = ["openclaw"];
+
+/** tslog-compatible level IDs (higher = more severe). */
+const LEVEL_IDS: Record<string, number> = {
+  TRACE: 1,
+  DEBUG: 2,
+  INFO: 3,
+  WARN: 4,
+  ERROR: 5,
+  FATAL: 6,
+};
+
+const DEFAULT_LOG_LEVEL = "INFO";
+
+function resolveMinLevel(): number {
+  const env = process.env.OPENCLAW_LOG_LEVEL?.toUpperCase();
+  if (env && env in LEVEL_IDS) return LEVEL_IDS[env];
+  return LEVEL_IDS[DEFAULT_LOG_LEVEL];
+}
+
+let minLevelId = resolveMinLevel();
+
+/** Dynamically change the minimum log level at runtime. */
+export function setLogLevel(level: string): void {
+  const upper = level.toUpperCase();
+  if (!(upper in LEVEL_IDS)) {
+    throw new Error(`Invalid log level: ${level}. Valid levels: ${Object.keys(LEVEL_IDS).join(", ")}`);
+  }
+  minLevelId = LEVEL_IDS[upper];
+}
+
+/** Shift a Date into local time so toISOString() renders local clock digits. */
+function toLocalISO(now: Date): string {
+  const offsetMs = -now.getTimezoneOffset() * 60_000;
+  const sign = offsetMs >= 0 ? "+" : "-";
+  const abs = Math.abs(now.getTimezoneOffset());
+  const offStr = `${sign}${String(Math.floor(abs / 60)).padStart(2, "0")}:${String(abs % 60).padStart(2, "0")}`;
+  return new Date(now.getTime() + offsetMs).toISOString().replace("Z", offStr);
+}
+
+function localDateKey(now: Date): string {
+  return toLocalISO(now).slice(0, 10);
+}
+
+function resolveMainLogPath(): string {
+  const dateKey = localDateKey(new Date());
+  return path.join(MAIN_LOG_DIR, `openclaw-${dateKey}.log`);
+}
+
+let logDirEnsured = false;
+
+export type Logger = {
+  info(message: string): void;
+  debug(message: string): void;
+  warn(message: string): void;
+  error(message: string): void;
+  /** Returns a child logger whose messages are prefixed with `[accountId]`. */
+  withAccount(accountId: string): Logger;
+  /** Returns the current main log file path. */
+  getLogFilePath(): string;
+  close(): void;
+};
+
+function buildLoggerName(accountId?: string): string {
+  return accountId ? `${SUBSYSTEM}/${accountId}` : SUBSYSTEM;
+}
+
+function writeLog(level: string, message: string, accountId?: string): void {
+  const levelId = LEVEL_IDS[level] ?? LEVEL_IDS.INFO;
+  if (levelId < minLevelId) return;
+
+  const now = new Date();
+  const loggerName = buildLoggerName(accountId);
+  const prefixedMessage = accountId ? `[${accountId}] ${message}` : message;
+  const entry = JSON.stringify({
+    "0": loggerName,
+    "1": prefixedMessage,
+    _meta: {
+      runtime: RUNTIME,
+      runtimeVersion: RUNTIME_VERSION,
+      hostname: HOSTNAME,
+      name: loggerName,
+      parentNames: PARENT_NAMES,
+      date: now.toISOString(),
+      logLevelId: LEVEL_IDS[level] ?? LEVEL_IDS.INFO,
+      logLevelName: level,
+    },
+    time: toLocalISO(now),
+  });
+  try {
+    if (!logDirEnsured) {
+      fs.mkdirSync(MAIN_LOG_DIR, { recursive: true });
+      logDirEnsured = true;
+    }
+    fs.appendFileSync(resolveMainLogPath(), `${entry}\n`, "utf-8");
+  } catch {
+    // Best-effort; never block on logging failures.
+  }
+}
+
+/** Creates a logger instance, optionally bound to a specific account. */
+function createLogger(accountId?: string): Logger {
+  return {
+    info(message: string): void {
+      writeLog("INFO", message, accountId);
+    },
+    debug(message: string): void {
+      writeLog("DEBUG", message, accountId);
+    },
+    warn(message: string): void {
+      writeLog("WARN", message, accountId);
+    },
+    error(message: string): void {
+      writeLog("ERROR", message, accountId);
+    },
+    withAccount(id: string): Logger {
+      return createLogger(id);
+    },
+    getLogFilePath(): string {
+      return resolveMainLogPath();
+    },
+    close(): void {
+      // No-op: appendFileSync has no persistent handle to close.
+    },
+  };
+}
+
+export const logger: Logger = createLogger();

package/setup-entry.ts

@@ -1,5 +0,0 @@
-import { defineSetupPluginEntry } from "openclaw/plugin-sdk/core";
-
-import { taideskPlugin } from "./src/channel.js";
-
-export default defineSetupPluginEntry(taideskPlugin);