import type {
ChannelMessageActionAdapter,
ChannelMessageActionName,
ChannelMessageToolDiscovery,
} from "openclaw/plugin-sdk/channel-contract" ;
import { createChatChannelPlugin } from "openclaw/plugin-sdk/channel-core" ;
import { createLoggedPairingApprovalNotifier } from "openclaw/plugin-sdk/channel-pairing" ;
import { createRestrictSendersChannelSecurity } from "openclaw/plugin-sdk/channel-policy" ;
import { createChannelDirectoryAdapter } from "openclaw/plugin-sdk/directory-runtime" ;
import { buildPassiveProbedChannelStatusSummary } from "openclaw/plugin-sdk/extension-shared" ;
import {
normalizeMessagePresentation,
presentationToInteractiveReply,
renderMessagePresentationFallbackText,
} from "openclaw/plugin-sdk/interactive-runtime" ;
import { createLazyRuntimeModule } from "openclaw/plugin-sdk/lazy-runtime" ;
import { isPrivateNetworkOptInEnabled } from "openclaw/plugin-sdk/ssrf-runtime" ;
import {
createComputedAccountStatusAdapter,
createDefaultChannelRuntimeState,
} from "openclaw/plugin-sdk/status-helpers" ;
import { normalizeOptionalString } from "openclaw/plugin-sdk/text-runtime" ;
import { mattermostApprovalAuth } from "./approval-auth.js" ;
import {
chunkTextForOutbound,
createAccountStatusSink,
DEFAULT_ACCOUNT_ID,
type ChannelPlugin,
} from "./channel-api.js" ;
import {
describeMattermostAccount,
isMattermostConfigured,
mattermostConfigAdapter,
mattermostMeta as meta,
normalizeMattermostAllowEntry as normalizeAllowEntry,
resolveMattermostGatewayAuthBypassPaths,
} from "./channel-config-shared.js" ;
import { MattermostChannelConfigSchema } from "./config-surface.js" ;
import { mattermostDoctor } from "./doctor.js" ;
import { resolveMattermostGroupRequireMention } from "./group-mentions.js" ;
import {
listMattermostAccountIds,
resolveDefaultMattermostAccountId,
resolveMattermostAccount,
resolveMattermostReplyToMode,
type ResolvedMattermostAccount,
} from "./mattermost/accounts.js" ;
import { looksLikeMattermostTargetId, normalizeMattermostMessagingTarget } from "./normalize.js" ;
import { collectRuntimeConfigAssignments, secretTargetRegistryEntries } from "./secret-contract.js" ;
import { resolveMattermostOutboundSessionRoute } from "./session-route.js" ;
import { mattermostSetupAdapter } from "./setup-core.js" ;
import { mattermostSetupWizard } from "./setup-surface.js" ;
import type { MattermostConfig } from "./types.js" ;
const loadMattermostChannelRuntime = createLazyRuntimeModule(() => import ("./channel.runtime.js" ));
const mattermostSecurityAdapter = createRestrictSendersChannelSecurity<ResolvedMattermostAccount>({
channelKey: "mattermost" ,
resolveDmPolicy: (account) => account.config.dmPolicy,
resolveDmAllowFrom: (account) => account.config.allowFrom,
resolveGroupPolicy: (account) => account.config.groupPolicy,
surface: "Mattermost channels" ,
openScope: "any member" ,
groupPolicyPath: "channels.mattermost.groupPolicy" ,
groupAllowFromPath: "channels.mattermost.groupAllowFrom" ,
policyPathSuffix: "dmPolicy" ,
normalizeDmEntry: (raw) => normalizeAllowEntry(raw),
});
function describeMattermostMessageTool({
cfg,
accountId,
}: Parameters<
NonNullable<ChannelMessageActionAdapter["describeMessageTool" ]>
>[0 ]): ChannelMessageToolDiscovery {
const enabledAccounts = (
accountId
? [resolveMattermostAccount({ cfg, accountId })]
: listMattermostAccountIds(cfg).map((listedAccountId) =>
resolveMattermostAccount({ cfg, accountId: listedAccountId }),
)
)
.filter((account) => account.enabled)
.filter((account) => Boolean (account.botToken?.trim() && account.baseUrl?.trim()));
const actions: ChannelMessageActionName[] = [];
if (enabledAccounts.length > 0 ) {
actions.push("send" );
}
const actionsConfig = cfg.channels?.mattermost?.actions as { reactions?: boolean } | undefined;
const baseReactions = actionsConfig?.reactions;
const hasReactionCapableAccount = enabledAccounts.some((account) => {
const accountActions = account.config.actions as { reactions?: boolean } | undefined;
return accountActions?.reactions ?? baseReactions ?? true ;
});
if (hasReactionCapableAccount) {
actions.push("react" );
}
return {
actions,
capabilities: enabledAccounts.length > 0 ? ["presentation" ] : [],
};
}
const mattermostMessageActions: ChannelMessageActionAdapter = {
describeMessageTool: describeMattermostMessageTool,
supportsAction: ({ action }) => {
return action === "send" || action === "react" ;
},
handleAction: async ({ action, params, cfg, accountId }) => {
if (action === "react" ) {
const resolvedAccountId = accountId ?? resolveDefaultMattermostAccountId(cfg);
const mattermostConfig = cfg.channels?.mattermost as MattermostConfig | undefined;
const account = resolveMattermostAccount({ cfg, accountId: resolvedAccountId });
const reactionsEnabled =
account.config.actions?.reactions ?? mattermostConfig?.actions?.reactions ?? true ;
if (!reactionsEnabled) {
throw new Error("Mattermost reactions are disabled in config" );
}
const { postId, emojiName, remove } = parseMattermostReactActionParams(params);
if (remove) {
const result = await (
await loadMattermostChannelRuntime()
).removeMattermostReaction({
cfg,
postId,
emojiName,
accountId: resolvedAccountId,
});
if (!result.ok) {
throw new Error(result.error);
}
return {
content: [
{ type: "text" as const , text: `Removed reaction :${emojiName}: from ${postId}` },
],
details: {},
};
}
const result = await (
await loadMattermostChannelRuntime()
).addMattermostReaction({
cfg,
postId,
emojiName,
accountId: resolvedAccountId,
});
if (!result.ok) {
throw new Error(result.error);
}
return {
content: [{ type: "text" as const , text: `Reacted with :${emojiName}: on ${postId}` }],
details: {},
};
}
if (action !== "send" ) {
throw new Error(`Unsupported Mattermost action: ${action}`);
}
// Send action with optional interactive buttons
const to =
typeof params.to === "string"
? params.to.trim()
: typeof params.target === "string"
? params.target.trim()
: "" ;
if (!to) {
throw new Error("Mattermost send requires a target (to)." );
}
const presentation = normalizeMessagePresentation(params.presentation);
const message = presentation
? renderMessagePresentationFallbackText({
text: typeof params.message === "string" ? params.message : "" ,
presentation,
})
: typeof params.message === "string"
? params.message
: "" ;
// Match the shared runner semantics: trim empty reply IDs away before
// falling back from replyToId to replyTo on direct plugin calls.
const replyToId =
normalizeOptionalString(params.replyToId) ?? normalizeOptionalString(params.replyTo);
const resolvedAccountId = accountId || undefined;
const mediaUrl =
typeof params.media === "string" ? params.media.trim() || undefined : undefined;
const result = await (
await loadMattermostChannelRuntime()
).sendMessageMattermost(to, message, {
cfg,
accountId: resolvedAccountId,
replyToId,
buttons: presentation
? presentationToInteractiveReply(presentation)
?.blocks.filter((block) => block.type === "buttons" )
.map((block) =>
block.buttons.flatMap((button) =>
button.value
? [
{
text: button.label,
callback_data: button.value,
style: button.style,
},
]
: [],
),
)
: undefined,
attachmentText: typeof params.attachmentText === "string" ? params.attachmentText : undefined,
mediaUrl,
});
return {
content: [
{
type: "text" as const ,
text: JSON.stringify({
ok: true ,
channel: "mattermost" ,
messageId: result.messageId,
channelId: result.channelId,
}),
},
],
details: {},
};
},
};
function parseMattermostReactActionParams(params: Record<string, unknown>): {
postId: string;
emojiName: string;
remove: boolean ;
} {
const postId =
normalizeOptionalString(params.messageId) ?? normalizeOptionalString(params.postId);
if (!postId) {
throw new Error("Mattermost react requires messageId (post id)" );
}
const emojiName = normalizeOptionalString(params.emoji)?.replace(/^:+|:+$/g, "" );
if (!emojiName) {
throw new Error("Mattermost react requires emoji" );
}
return {
postId,
emojiName,
remove: params.remove === true ,
};
}
export const mattermostPlugin: ChannelPlugin<ResolvedMattermostAccount> = createChatChannelPlugin({
base: {
id: "mattermost" ,
meta: {
...meta,
},
setup: mattermostSetupAdapter,
setupWizard: mattermostSetupWizard,
capabilities: {
chatTypes: ["direct" , "channel" , "group" , "thread" ],
reactions: true ,
threads: true ,
media: true ,
nativeCommands: true ,
},
streaming: {
blockStreamingCoalesceDefaults: { minChars: 1500 , idleMs: 1000 },
},
reload: { configPrefixes: ["channels.mattermost" ] },
configSchema: MattermostChannelConfigSchema,
config: {
...mattermostConfigAdapter,
isConfigured: isMattermostConfigured,
describeAccount: describeMattermostAccount,
},
approvalCapability: mattermostApprovalAuth,
doctor: mattermostDoctor,
groups: {
resolveRequireMention: resolveMattermostGroupRequireMention,
},
actions: mattermostMessageActions,
secrets: {
secretTargetRegistryEntries,
collectRuntimeConfigAssignments,
},
directory: createChannelDirectoryAdapter({
listGroups: async (params) =>
(await loadMattermostChannelRuntime()).listMattermostDirectoryGroups(params),
listGroupsLive: async (params) =>
(await loadMattermostChannelRuntime()).listMattermostDirectoryGroups(params),
listPeers: async (params) =>
(await loadMattermostChannelRuntime()).listMattermostDirectoryPeers(params),
listPeersLive: async (params) =>
(await loadMattermostChannelRuntime()).listMattermostDirectoryPeers(params),
}),
messaging: {
defaultMarkdownTableMode: "off" ,
normalizeTarget: normalizeMattermostMessagingTarget,
resolveDeliveryTarget: ({ conversationId, parentConversationId }) => {
const parent = parentConversationId?.trim();
const child = conversationId.trim();
return parent && parent !== child
? { to: `channel:${parent}`, threadId: child }
: { to: normalizeMattermostMessagingTarget(`channel:${child}`) };
},
resolveOutboundSessionRoute: (params) => resolveMattermostOutboundSessionRoute(params),
targetResolver: {
looksLikeId: looksLikeMattermostTargetId,
hint: "<channelId|user:ID|channel:ID>" ,
resolveTarget: async ({ cfg, accountId, input }) => {
const resolved = await (
await loadMattermostChannelRuntime()
).resolveMattermostOpaqueTarget({
input,
cfg,
accountId,
});
if (!resolved) {
return null ;
}
return {
to: resolved.to,
kind: resolved.kind,
source: "directory" ,
};
},
},
},
status: createComputedAccountStatusAdapter<ResolvedMattermostAccount>({
defaultRuntime: createDefaultChannelRuntimeState(DEFAULT_ACCOUNT_ID, {
connected: false ,
lastConnectedAt: null ,
lastDisconnect: null ,
}),
buildChannelSummary: ({ snapshot }) =>
buildPassiveProbedChannelStatusSummary(snapshot, {
botTokenSource: snapshot.botTokenSource ?? "none" ,
connected: snapshot.connected ?? false ,
baseUrl: snapshot.baseUrl ?? null ,
}),
probeAccount: async ({ account, timeoutMs }) => {
const token = account.botToken?.trim();
const baseUrl = account.baseUrl?.trim();
if (!token || !baseUrl) {
return { ok: false , error: "bot token or baseUrl missing" };
}
return await (
await loadMattermostChannelRuntime()
).probeMattermost(baseUrl, token, timeoutMs, isPrivateNetworkOptInEnabled(account.config));
},
resolveAccountSnapshot: ({ account, runtime }) => ({
accountId: account.accountId,
name: account.name,
enabled: account.enabled,
configured: Boolean (account.botToken && account.baseUrl),
extra: {
botTokenSource: account.botTokenSource,
baseUrl: account.baseUrl,
connected: runtime?.connected ?? false ,
lastConnectedAt: runtime?.lastConnectedAt ?? null ,
lastDisconnect: runtime?.lastDisconnect ?? null ,
},
}),
}),
gateway: {
resolveGatewayAuthBypassPaths: ({ cfg }) => resolveMattermostGatewayAuthBypassPaths(cfg),
startAccount: async (ctx) => {
const account = ctx.account;
const statusSink = createAccountStatusSink({
accountId: ctx.accountId,
setStatus: ctx.setStatus,
});
statusSink({
baseUrl: account.baseUrl,
botTokenSource: account.botTokenSource,
});
ctx.log?.info(`[${account.accountId}] starting channel`);
return (await loadMattermostChannelRuntime()).monitorMattermostProvider({
botToken: account.botToken ?? undefined,
baseUrl: account.baseUrl ?? undefined,
accountId: account.accountId,
config: ctx.cfg,
runtime: ctx.runtime,
abortSignal: ctx.abortSignal,
statusSink,
});
},
},
},
pairing: {
text: {
idLabel: "mattermostUserId" ,
message: "OpenClaw: your access has been approved." ,
normalizeAllowEntry: (entry) => normalizeAllowEntry(entry),
notify: createLoggedPairingApprovalNotifier(
({ id }) => `[mattermost] User ${id} approved for pairing`,
),
},
},
threading: {
scopedAccountReplyToMode: {
resolveAccount: (cfg, accountId) =>
resolveMattermostAccount({
cfg,
accountId: accountId ?? resolveDefaultMattermostAccountId(cfg),
}),
resolveReplyToMode: (account, chatType) =>
resolveMattermostReplyToMode(
account,
chatType === "direct" || chatType === "group" || chatType === "channel"
? chatType
: "channel" ,
),
},
resolveReplyTransport: ({ threadId, replyToId }) => ({
replyToId: replyToId ?? (threadId != null ? String(threadId) : undefined),
threadId,
}),
},
security: mattermostSecurityAdapter,
outbound: {
base: {
deliveryMode: "direct" ,
chunker: chunkTextForOutbound,
chunkerMode: "markdown" ,
textChunkLimit: 4000 ,
resolveTarget: ({ to }) => {
const trimmed = to?.trim();
if (!trimmed) {
return {
ok: false ,
error: new Error(
"Delivering to Mattermost requires --to <channelId|@username|user:ID|channel:ID>" ,
),
};
}
return { ok: true , to: trimmed };
},
},
attachedResults: {
channel: "mattermost" ,
sendText: async ({ cfg, to, text, accountId, replyToId, threadId }) =>
await (
await loadMattermostChannelRuntime()
).sendMessageMattermost(to, text, {
cfg,
accountId: accountId ?? undefined,
replyToId: replyToId ?? (threadId != null ? String(threadId) : undefined),
}),
sendMedia: async ({
cfg,
to,
text,
mediaUrl,
mediaLocalRoots,
accountId,
replyToId,
threadId,
}) =>
await (
await loadMattermostChannelRuntime()
).sendMessageMattermost(to, text, {
cfg,
accountId: accountId ?? undefined,
mediaUrl,
mediaLocalRoots,
replyToId: replyToId ?? (threadId != null ? String(threadId) : undefined),
}),
},
},
});
Messung V0.5 in Prozent C=100 H=99 G=99
¤ Dauer der Verarbeitung: 0.12 Sekunden
(vorverarbeitet am 2026-06-07)
¤
*© Formatika GbR, Deutschland