@openclaw/mattermost 2026.2.21 → 2026.6.11-beta.2

package/src/mattermost/send.ts

@@ -1,231 +0,0 @@
-import { getMattermostRuntime } from "../runtime.js";
-import { resolveMattermostAccount } from "./accounts.js";
-import {
-  createMattermostClient,
-  createMattermostDirectChannel,
-  createMattermostPost,
-  fetchMattermostMe,
-  fetchMattermostUserByUsername,
-  normalizeMattermostBaseUrl,
-  uploadMattermostFile,
-  type MattermostUser,
-} from "./client.js";
-
-export type MattermostSendOpts = {
-  botToken?: string;
-  baseUrl?: string;
-  accountId?: string;
-  mediaUrl?: string;
-  replyToId?: string;
-};
-
-export type MattermostSendResult = {
-  messageId: string;
-  channelId: string;
-};
-
-type MattermostTarget =
-  | { kind: "channel"; id: string }
-  | { kind: "user"; id?: string; username?: string };
-
-const botUserCache = new Map<string, MattermostUser>();
-const userByNameCache = new Map<string, MattermostUser>();
-
-const getCore = () => getMattermostRuntime();
-
-function cacheKey(baseUrl: string, token: string): string {
-  return `${baseUrl}::${token}`;
-}
-
-function normalizeMessage(text: string, mediaUrl?: string): string {
-  const trimmed = text.trim();
-  const media = mediaUrl?.trim();
-  return [trimmed, media].filter(Boolean).join("\n");
-}
-
-function isHttpUrl(value: string): boolean {
-  return /^https?:\/\//i.test(value);
-}
-
-function parseMattermostTarget(raw: string): MattermostTarget {
-  const trimmed = raw.trim();
-  if (!trimmed) {
-    throw new Error("Recipient is required for Mattermost sends");
-  }
-  const lower = trimmed.toLowerCase();
-  if (lower.startsWith("channel:")) {
-    const id = trimmed.slice("channel:".length).trim();
-    if (!id) {
-      throw new Error("Channel id is required for Mattermost sends");
-    }
-    return { kind: "channel", id };
-  }
-  if (lower.startsWith("user:")) {
-    const id = trimmed.slice("user:".length).trim();
-    if (!id) {
-      throw new Error("User id is required for Mattermost sends");
-    }
-    return { kind: "user", id };
-  }
-  if (lower.startsWith("mattermost:")) {
-    const id = trimmed.slice("mattermost:".length).trim();
-    if (!id) {
-      throw new Error("User id is required for Mattermost sends");
-    }
-    return { kind: "user", id };
-  }
-  if (trimmed.startsWith("@")) {
-    const username = trimmed.slice(1).trim();
-    if (!username) {
-      throw new Error("Username is required for Mattermost sends");
-    }
-    return { kind: "user", username };
-  }
-  return { kind: "channel", id: trimmed };
-}
-
-async function resolveBotUser(baseUrl: string, token: string): Promise<MattermostUser> {
-  const key = cacheKey(baseUrl, token);
-  const cached = botUserCache.get(key);
-  if (cached) {
-    return cached;
-  }
-  const client = createMattermostClient({ baseUrl, botToken: token });
-  const user = await fetchMattermostMe(client);
-  botUserCache.set(key, user);
-  return user;
-}
-
-async function resolveUserIdByUsername(params: {
-  baseUrl: string;
-  token: string;
-  username: string;
-}): Promise<string> {
-  const { baseUrl, token, username } = params;
-  const key = `${cacheKey(baseUrl, token)}::${username.toLowerCase()}`;
-  const cached = userByNameCache.get(key);
-  if (cached?.id) {
-    return cached.id;
-  }
-  const client = createMattermostClient({ baseUrl, botToken: token });
-  const user = await fetchMattermostUserByUsername(client, username);
-  userByNameCache.set(key, user);
-  return user.id;
-}
-
-async function resolveTargetChannelId(params: {
-  target: MattermostTarget;
-  baseUrl: string;
-  token: string;
-}): Promise<string> {
-  if (params.target.kind === "channel") {
-    return params.target.id;
-  }
-  const userId = params.target.id
-    ? params.target.id
-    : await resolveUserIdByUsername({
-        baseUrl: params.baseUrl,
-        token: params.token,
-        username: params.target.username ?? "",
-      });
-  const botUser = await resolveBotUser(params.baseUrl, params.token);
-  const client = createMattermostClient({
-    baseUrl: params.baseUrl,
-    botToken: params.token,
-  });
-  const channel = await createMattermostDirectChannel(client, [botUser.id, userId]);
-  return channel.id;
-}
-
-export async function sendMessageMattermost(
-  to: string,
-  text: string,
-  opts: MattermostSendOpts = {},
-): Promise<MattermostSendResult> {
-  const core = getCore();
-  const logger = core.logging.getChildLogger({ module: "mattermost" });
-  const cfg = core.config.loadConfig();
-  const account = resolveMattermostAccount({
-    cfg,
-    accountId: opts.accountId,
-  });
-  const token = opts.botToken?.trim() || account.botToken?.trim();
-  if (!token) {
-    throw new Error(
-      `Mattermost bot token missing for account "${account.accountId}" (set channels.mattermost.accounts.${account.accountId}.botToken or MATTERMOST_BOT_TOKEN for default).`,
-    );
-  }
-  const baseUrl = normalizeMattermostBaseUrl(opts.baseUrl ?? account.baseUrl);
-  if (!baseUrl) {
-    throw new Error(
-      `Mattermost baseUrl missing for account "${account.accountId}" (set channels.mattermost.accounts.${account.accountId}.baseUrl or MATTERMOST_URL for default).`,
-    );
-  }
-
-  const target = parseMattermostTarget(to);
-  const channelId = await resolveTargetChannelId({
-    target,
-    baseUrl,
-    token,
-  });
-
-  const client = createMattermostClient({ baseUrl, botToken: token });
-  let message = text?.trim() ?? "";
-  let fileIds: string[] | undefined;
-  let uploadError: Error | undefined;
-  const mediaUrl = opts.mediaUrl?.trim();
-  if (mediaUrl) {
-    try {
-      const media = await core.media.loadWebMedia(mediaUrl);
-      const fileInfo = await uploadMattermostFile(client, {
-        channelId,
-        buffer: media.buffer,
-        fileName: media.fileName ?? "upload",
-        contentType: media.contentType ?? undefined,
-      });
-      fileIds = [fileInfo.id];
-    } catch (err) {
-      uploadError = err instanceof Error ? err : new Error(String(err));
-      if (core.logging.shouldLogVerbose()) {
-        logger.debug?.(
-          `mattermost send: media upload failed, falling back to URL text: ${String(err)}`,
-        );
-      }
-      message = normalizeMessage(message, isHttpUrl(mediaUrl) ? mediaUrl : "");
-    }
-  }
-
-  if (message) {
-    const tableMode = core.channel.text.resolveMarkdownTableMode({
-      cfg,
-      channel: "mattermost",
-      accountId: account.accountId,
-    });
-    message = core.channel.text.convertMarkdownTables(message, tableMode);
-  }
-
-  if (!message && (!fileIds || fileIds.length === 0)) {
-    if (uploadError) {
-      throw new Error(`Mattermost media upload failed: ${uploadError.message}`);
-    }
-    throw new Error("Mattermost message is empty");
-  }
-
-  const post = await createMattermostPost(client, {
-    channelId,
-    message,
-    rootId: opts.replyToId,
-    fileIds,
-  });
-
-  core.channel.activity.record({
-    channel: "mattermost",
-    accountId: account.accountId,
-    direction: "outbound",
-  });
-
-  return {
-    messageId: post.id ?? "unknown",
-    channelId,
-  };
-}

package/src/normalize.ts

@@ -1,46 +0,0 @@
-export function normalizeMattermostMessagingTarget(raw: string): string | undefined {
-  const trimmed = raw.trim();
-  if (!trimmed) {
-    return undefined;
-  }
-  const lower = trimmed.toLowerCase();
-  if (lower.startsWith("channel:")) {
-    const id = trimmed.slice("channel:".length).trim();
-    return id ? `channel:${id}` : undefined;
-  }
-  if (lower.startsWith("group:")) {
-    const id = trimmed.slice("group:".length).trim();
-    return id ? `channel:${id}` : undefined;
-  }
-  if (lower.startsWith("user:")) {
-    const id = trimmed.slice("user:".length).trim();
-    return id ? `user:${id}` : undefined;
-  }
-  if (lower.startsWith("mattermost:")) {
-    const id = trimmed.slice("mattermost:".length).trim();
-    return id ? `user:${id}` : undefined;
-  }
-  if (trimmed.startsWith("@")) {
-    const id = trimmed.slice(1).trim();
-    return id ? `@${id}` : undefined;
-  }
-  if (trimmed.startsWith("#")) {
-    const id = trimmed.slice(1).trim();
-    return id ? `channel:${id}` : undefined;
-  }
-  return `channel:${trimmed}`;
-}
-
-export function looksLikeMattermostTargetId(raw: string): boolean {
-  const trimmed = raw.trim();
-  if (!trimmed) {
-    return false;
-  }
-  if (/^(user|channel|group|mattermost):/i.test(trimmed)) {
-    return true;
-  }
-  if (/^[@#]/.test(trimmed)) {
-    return true;
-  }
-  return /^[a-z0-9]{8,}$/i.test(trimmed);
-}

package/src/onboarding-helpers.ts

@@ -1 +0,0 @@
-export { promptAccountId } from "openclaw/plugin-sdk";

package/src/onboarding.ts

@@ -1,186 +0,0 @@
-import type { ChannelOnboardingAdapter, OpenClawConfig, WizardPrompter } from "openclaw/plugin-sdk";
-import { DEFAULT_ACCOUNT_ID, normalizeAccountId } from "openclaw/plugin-sdk/account-id";
-import {
-  listMattermostAccountIds,
-  resolveDefaultMattermostAccountId,
-  resolveMattermostAccount,
-} from "./mattermost/accounts.js";
-import { promptAccountId } from "./onboarding-helpers.js";
-
-const channel = "mattermost" as const;
-
-async function noteMattermostSetup(prompter: WizardPrompter): Promise<void> {
-  await prompter.note(
-    [
-      "1) Mattermost System Console -> Integrations -> Bot Accounts",
-      "2) Create a bot + copy its token",
-      "3) Use your server base URL (e.g., https://chat.example.com)",
-      "Tip: the bot must be a member of any channel you want it to monitor.",
-      "Docs: https://docs.openclaw.ai/channels/mattermost",
-    ].join("\n"),
-    "Mattermost bot token",
-  );
-}
-
-export const mattermostOnboardingAdapter: ChannelOnboardingAdapter = {
-  channel,
-  getStatus: async ({ cfg }) => {
-    const configured = listMattermostAccountIds(cfg).some((accountId) => {
-      const account = resolveMattermostAccount({ cfg, accountId });
-      return Boolean(account.botToken && account.baseUrl);
-    });
-    return {
-      channel,
-      configured,
-      statusLines: [`Mattermost: ${configured ? "configured" : "needs token + url"}`],
-      selectionHint: configured ? "configured" : "needs setup",
-      quickstartScore: configured ? 2 : 1,
-    };
-  },
-  configure: async ({ cfg, prompter, accountOverrides, shouldPromptAccountIds }) => {
-    const override = accountOverrides.mattermost?.trim();
-    const defaultAccountId = resolveDefaultMattermostAccountId(cfg);
-    let accountId = override ? normalizeAccountId(override) : defaultAccountId;
-    if (shouldPromptAccountIds && !override) {
-      accountId = await promptAccountId({
-        cfg,
-        prompter,
-        label: "Mattermost",
-        currentId: accountId,
-        listAccountIds: listMattermostAccountIds,
-        defaultAccountId,
-      });
-    }
-
-    let next = cfg;
-    const resolvedAccount = resolveMattermostAccount({
-      cfg: next,
-      accountId,
-    });
-    const accountConfigured = Boolean(resolvedAccount.botToken && resolvedAccount.baseUrl);
-    const allowEnv = accountId === DEFAULT_ACCOUNT_ID;
-    const canUseEnv =
-      allowEnv &&
-      Boolean(process.env.MATTERMOST_BOT_TOKEN?.trim()) &&
-      Boolean(process.env.MATTERMOST_URL?.trim());
-    const hasConfigValues =
-      Boolean(resolvedAccount.config.botToken) || Boolean(resolvedAccount.config.baseUrl);
-
-    let botToken: string | null = null;
-    let baseUrl: string | null = null;
-
-    if (!accountConfigured) {
-      await noteMattermostSetup(prompter);
-    }
-
-    if (canUseEnv && !hasConfigValues) {
-      const keepEnv = await prompter.confirm({
-        message: "MATTERMOST_BOT_TOKEN + MATTERMOST_URL detected. Use env vars?",
-        initialValue: true,
-      });
-      if (keepEnv) {
-        next = {
-          ...next,
-          channels: {
-            ...next.channels,
-            mattermost: {
-              ...next.channels?.mattermost,
-              enabled: true,
-            },
-          },
-        };
-      } else {
-        botToken = String(
-          await prompter.text({
-            message: "Enter Mattermost bot token",
-            validate: (value) => (value?.trim() ? undefined : "Required"),
-          }),
-        ).trim();
-        baseUrl = String(
-          await prompter.text({
-            message: "Enter Mattermost base URL",
-            validate: (value) => (value?.trim() ? undefined : "Required"),
-          }),
-        ).trim();
-      }
-    } else if (accountConfigured) {
-      const keep = await prompter.confirm({
-        message: "Mattermost credentials already configured. Keep them?",
-        initialValue: true,
-      });
-      if (!keep) {
-        botToken = String(
-          await prompter.text({
-            message: "Enter Mattermost bot token",
-            validate: (value) => (value?.trim() ? undefined : "Required"),
-          }),
-        ).trim();
-        baseUrl = String(
-          await prompter.text({
-            message: "Enter Mattermost base URL",
-            validate: (value) => (value?.trim() ? undefined : "Required"),
-          }),
-        ).trim();
-      }
-    } else {
-      botToken = String(
-        await prompter.text({
-          message: "Enter Mattermost bot token",
-          validate: (value) => (value?.trim() ? undefined : "Required"),
-        }),
-      ).trim();
-      baseUrl = String(
-        await prompter.text({
-          message: "Enter Mattermost base URL",
-          validate: (value) => (value?.trim() ? undefined : "Required"),
-        }),
-      ).trim();
-    }
-
-    if (botToken || baseUrl) {
-      if (accountId === DEFAULT_ACCOUNT_ID) {
-        next = {
-          ...next,
-          channels: {
-            ...next.channels,
-            mattermost: {
-              ...next.channels?.mattermost,
-              enabled: true,
-              ...(botToken ? { botToken } : {}),
-              ...(baseUrl ? { baseUrl } : {}),
-            },
-          },
-        };
-      } else {
-        next = {
-          ...next,
-          channels: {
-            ...next.channels,
-            mattermost: {
-              ...next.channels?.mattermost,
-              enabled: true,
-              accounts: {
-                ...next.channels?.mattermost?.accounts,
-                [accountId]: {
-                  ...next.channels?.mattermost?.accounts?.[accountId],
-                  enabled: next.channels?.mattermost?.accounts?.[accountId]?.enabled ?? true,
-                  ...(botToken ? { botToken } : {}),
-                  ...(baseUrl ? { baseUrl } : {}),
-                },
-              },
-            },
-          },
-        };
-      }
-    }
-
-    return { cfg: next, accountId };
-  },
-  disable: (cfg: OpenClawConfig) => ({
-    ...cfg,
-    channels: {
-      ...cfg.channels,
-      mattermost: { ...cfg.channels?.mattermost, enabled: false },
-    },
-  }),
-};

package/src/runtime.ts

@@ -1,14 +0,0 @@
-import type { PluginRuntime } from "openclaw/plugin-sdk";
-
-let runtime: PluginRuntime | null = null;
-
-export function setMattermostRuntime(next: PluginRuntime) {
-  runtime = next;
-}
-
-export function getMattermostRuntime(): PluginRuntime {
-  if (!runtime) {
-    throw new Error("Mattermost runtime not initialized");
-  }
-  return runtime;
-}

package/src/types.ts

@@ -1,57 +0,0 @@
-import type { BlockStreamingCoalesceConfig, DmPolicy, GroupPolicy } from "openclaw/plugin-sdk";
-
-export type MattermostChatMode = "oncall" | "onmessage" | "onchar";
-
-export type MattermostAccountConfig = {
-  /** Optional display name for this account (used in CLI/UI lists). */
-  name?: string;
-  /** Optional provider capability tags used for agent/runtime guidance. */
-  capabilities?: string[];
-  /** Allow channel-initiated config writes (default: true). */
-  configWrites?: boolean;
-  /** If false, do not start this Mattermost account. Default: true. */
-  enabled?: boolean;
-  /** Bot token for Mattermost. */
-  botToken?: string;
-  /** Base URL for the Mattermost server (e.g., https://chat.example.com). */
-  baseUrl?: string;
-  /**
-   * Controls when channel messages trigger replies.
-   * - "oncall": only respond when mentioned
-   * - "onmessage": respond to every channel message
-   * - "onchar": respond when a trigger character prefixes the message
-   */
-  chatmode?: MattermostChatMode;
-  /** Prefix characters that trigger onchar mode (default: [">", "!"]). */
-  oncharPrefixes?: string[];
-  /** Require @mention to respond in channels. Default: true. */
-  requireMention?: boolean;
-  /** Direct message policy (pairing/allowlist/open/disabled). */
-  dmPolicy?: DmPolicy;
-  /** Allowlist for direct messages (user ids or @usernames). */
-  allowFrom?: Array<string | number>;
-  /** Allowlist for group messages (user ids or @usernames). */
-  groupAllowFrom?: Array<string | number>;
-  /** Group message policy (allowlist/open/disabled). */
-  groupPolicy?: GroupPolicy;
-  /** Outbound text chunk size (chars). Default: 4000. */
-  textChunkLimit?: number;
-  /** Chunking mode: "length" (default) splits by size; "newline" splits on every newline. */
-  chunkMode?: "length" | "newline";
-  /** Disable block streaming for this account. */
-  blockStreaming?: boolean;
-  /** Merge streamed block replies before sending. */
-  blockStreamingCoalesce?: BlockStreamingCoalesceConfig;
-  /** Outbound response prefix override for this channel/account. */
-  responsePrefix?: string;
-  /** Action toggles for this account. */
-  actions?: {
-    /** Enable message reaction actions. Default: true. */
-    reactions?: boolean;
-  };
-};
-
-export type MattermostConfig = {
-  /** Optional per-account Mattermost configuration (multi-account). */
-  accounts?: Record<string, MattermostAccountConfig>;
-} & MattermostAccountConfig;