@workclaw/openclaw-workchat 1.0.0 → 1.0.3

package/src/compat.ts

@@ -1,75 +1,75 @@
-/**
- * Runtime host-version compatibility check for openclaw-workchat.
- *
- * 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 { logger } from "./util/logger.js";
-
-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(
-    `This version of openclaw-workchat requires OpenClaw >=${SUPPORTED_HOST_MIN}, ` +
-    `but found ${hostVersion}. Please upgrade OpenClaw.`,
-  );
-}
+/**
+ * Runtime host-version compatibility check for openclaw-workchat.
+ *
+ * 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 { logger } from "./util/logger.js";
+
+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(
+    `This version of openclaw-workchat requires OpenClaw >=${SUPPORTED_HOST_MIN}, ` +
+    `but found ${hostVersion}. Please upgrade OpenClaw.`,
+  );
+}

package/src/config/config-schema.ts

@@ -1,29 +1,29 @@
-import { z } from "zod";
-
-import { DEFAULT_BASE_URL, DEFAULT_WS_URL } from "../api/types.js";
-
-// ---------------------------------------------------------------------------
-// Zod config schema
-// ---------------------------------------------------------------------------
-
-const workchatAccountSchema = z.object({
-  name: z.string().optional(),
-  enabled: z.boolean().optional(),
-  agentId: z.union([z.string(), z.number()]).optional(),
-  userId: z.union([z.string(), z.number()]).optional(),
-});
-
-/** Top-level workchat config schema (appKey/appSecret are env placeholders). */
-export const WorkChatConfigSchema = workchatAccountSchema.extend({
-  baseUrl: z.string().default(DEFAULT_BASE_URL),
-  websocketUrl: z.string().default(DEFAULT_WS_URL),
-  /** `${WORKCHAT_API_KEY}` secret placeholder — resolved from gateway env. */
-  appKey: z.string().optional(),
-  /** `${WORKCHAT_APP_SECRET}` secret placeholder — resolved from gateway env. */
-  appSecret: z.string().optional(),
-  allowInsecureTls: z.boolean().optional(),
-  requestTimeout: z.number().int().positive().optional(),
-  accounts: z.record(z.string(), workchatAccountSchema).optional(),
-  /** ISO 8601; bumped on each successful binding to refresh gateway config from disk. */
-  channelConfigUpdatedAt: z.string().optional(),
-});
+import { z } from "zod";
+
+import { DEFAULT_BASE_URL, DEFAULT_WS_URL } from "../api/types.js";
+
+// ---------------------------------------------------------------------------
+// Zod config schema
+// ---------------------------------------------------------------------------
+
+const workchatAccountSchema = z.object({
+  name: z.string().optional(),
+  enabled: z.boolean().optional(),
+  agentId: z.union([z.string(), z.number()]).optional(),
+  userId: z.union([z.string(), z.number()]).optional(),
+});
+
+/** Top-level workchat config schema (appKey/appSecret are env placeholders). */
+export const WorkChatConfigSchema = workchatAccountSchema.extend({
+  baseUrl: z.string().default(DEFAULT_BASE_URL),
+  websocketUrl: z.string().default(DEFAULT_WS_URL),
+  /** `${WORKCHAT_API_KEY}` secret placeholder — resolved from gateway env. */
+  appKey: z.string().optional(),
+  /** `${WORKCHAT_APP_SECRET}` secret placeholder — resolved from gateway env. */
+  appSecret: z.string().optional(),
+  allowInsecureTls: z.boolean().optional(),
+  requestTimeout: z.number().int().positive().optional(),
+  accounts: z.record(z.string(), workchatAccountSchema).optional(),
+  /** ISO 8601; bumped on each successful binding to refresh gateway config from disk. */
+  channelConfigUpdatedAt: z.string().optional(),
+});

package/src/messaging/debug-mode.ts

@@ -1,57 +1,57 @@
-/**
- * Per-bot debug mode toggle, persisted to disk so it survives gateway restarts.
- *
- * State file: `<stateDir>/openclaw-workchat/debug-mode.json`
- * Format:     `{ "accounts": { "<accountId>": true, ... } }`
- *
- * When enabled, processOneFrame appends a timing summary after each
- * AI reply is delivered to the user.
- */
-import fs from "node:fs";
-import path from "node:path";
-
-import { resolveStateDir } from "../storage/state-dir.js";
-import { logger } from "../util/logger.js";
-
-interface DebugModeState {
-  accounts: Record<string, boolean>;
-}
-
-function resolveDebugModePath(): string {
-  return path.join(resolveStateDir(), "openclaw-workchat", "debug-mode.json");
-}
-
-function loadState(): DebugModeState {
-  try {
-    const raw = fs.readFileSync(resolveDebugModePath(), "utf-8");
-    const parsed = JSON.parse(raw) as DebugModeState;
-    if (parsed && typeof parsed.accounts === "object") return parsed;
-  } catch {
-    // missing or corrupt — start fresh
-  }
-  return { accounts: {} };
-}
-
-function saveState(state: DebugModeState): void {
-  const filePath = resolveDebugModePath();
-  fs.mkdirSync(path.dirname(filePath), { recursive: true });
-  fs.writeFileSync(filePath, JSON.stringify(state, null, 2), "utf-8");
-}
-
-/** Toggle debug mode for a bot account. Returns the new state. */
-export function toggleDebugMode(accountId: string): boolean {
-  const state = loadState();
-  const next = !state.accounts[accountId];
-  state.accounts[accountId] = next;
-  try {
-    saveState(state);
-  } catch (err) {
-    logger.error(`debug-mode: failed to persist state: ${String(err)}`);
-  }
-  return next;
-}
-
-/** Check whether debug mode is active for a bot account. */
-export function isDebugMode(accountId: string): boolean {
-  return loadState().accounts[accountId] === true;
-}
+/**
+ * Per-bot debug mode toggle, persisted to disk so it survives gateway restarts.
+ *
+ * State file: `<stateDir>/openclaw-workchat/debug-mode.json`
+ * Format:     `{ "accounts": { "<accountId>": true, ... } }`
+ *
+ * When enabled, processOneFrame appends a timing summary after each
+ * AI reply is delivered to the user.
+ */
+import fs from "node:fs";
+import path from "node:path";
+
+import { resolveStateDir } from "../storage/state-dir.js";
+import { logger } from "../util/logger.js";
+
+interface DebugModeState {
+  accounts: Record<string, boolean>;
+}
+
+function resolveDebugModePath(): string {
+  return path.join(resolveStateDir(), "openclaw-workchat", "debug-mode.json");
+}
+
+function loadState(): DebugModeState {
+  try {
+    const raw = fs.readFileSync(resolveDebugModePath(), "utf-8");
+    const parsed = JSON.parse(raw) as DebugModeState;
+    if (parsed && typeof parsed.accounts === "object") return parsed;
+  } catch {
+    // missing or corrupt — start fresh
+  }
+  return { accounts: {} };
+}
+
+function saveState(state: DebugModeState): void {
+  const filePath = resolveDebugModePath();
+  fs.mkdirSync(path.dirname(filePath), { recursive: true });
+  fs.writeFileSync(filePath, JSON.stringify(state, null, 2), "utf-8");
+}
+
+/** Toggle debug mode for a bot account. Returns the new state. */
+export function toggleDebugMode(accountId: string): boolean {
+  const state = loadState();
+  const next = !state.accounts[accountId];
+  state.accounts[accountId] = next;
+  try {
+    saveState(state);
+  } catch (err) {
+    logger.error(`debug-mode: failed to persist state: ${String(err)}`);
+  }
+  return next;
+}
+
+/** Check whether debug mode is active for a bot account. */
+export function isDebugMode(accountId: string): boolean {
+  return loadState().accounts[accountId] === true;
+}

package/src/messaging/error-notice.ts

@@ -1,30 +1,30 @@
-import type { WorkChatApiOptions } from "../api/api.js";
-import { logger } from "../util/logger.js";
-
-import { pushWorkChatMessage } from "./send.js";
-import type { ResolvedWorkChatAccount } from "../auth/accounts.js";
-
-/**
- * Send a plain-text error notice back to the user.
- * Fire-and-forget: errors are logged but never thrown, so callers stay unaffected.
- */
-export async function sendWorkChatErrorNotice(params: {
-  account: ResolvedWorkChatAccount;
-  to: string;
-  message: string;
-  agentId?: string;
-  apiOpts?: WorkChatApiOptions;
-  errLog: (m: string) => void;
-}): Promise<void> {
-  try {
-    await pushWorkChatMessage({
-      account: params.account,
-      to: params.to,
-      text: params.message,
-      agentId: params.agentId,
-    });
-    logger.debug(`sendWorkChatErrorNotice: sent to=${params.to}`);
-  } catch (err) {
-    params.errLog(`[workchat] sendWorkChatErrorNotice failed to=${params.to}: ${String(err)}`);
-  }
-}
+import type { WorkChatApiOptions } from "../api/api.js";
+import { logger } from "../util/logger.js";
+
+import { pushWorkChatMessage } from "./send.js";
+import type { ResolvedWorkChatAccount } from "../auth/accounts.js";
+
+/**
+ * Send a plain-text error notice back to the user.
+ * Fire-and-forget: errors are logged but never thrown, so callers stay unaffected.
+ */
+export async function sendWorkChatErrorNotice(params: {
+  account: ResolvedWorkChatAccount;
+  to: string;
+  message: string;
+  agentId?: string;
+  apiOpts?: WorkChatApiOptions;
+  errLog: (m: string) => void;
+}): Promise<void> {
+  try {
+    await pushWorkChatMessage({
+      account: params.account,
+      to: params.to,
+      text: params.message,
+      agentId: params.agentId,
+    });
+    logger.debug(`sendWorkChatErrorNotice: sent to=${params.to}`);
+  } catch (err) {
+    params.errLog(`[workchat] sendWorkChatErrorNotice failed to=${params.to}: ${String(err)}`);
+  }
+}