129 lines
4.0 KiB
TypeScript
129 lines
4.0 KiB
TypeScript
import {
|
|
createScopedChannelConfigAdapter,
|
|
createScopedDmSecurityResolver,
|
|
} from "openclaw/plugin-sdk/channel-config-helpers";
|
|
import { createAllowlistProviderRestrictSendersWarningCollector } from "openclaw/plugin-sdk/channel-policy";
|
|
import { createChannelPluginBase } from "openclaw/plugin-sdk/core";
|
|
import {
|
|
listSignalAccountIds,
|
|
resolveDefaultSignalAccountId,
|
|
resolveSignalAccount,
|
|
type ResolvedSignalAccount,
|
|
} from "./accounts.js";
|
|
import {
|
|
buildChannelConfigSchema,
|
|
getChatChannelMeta,
|
|
normalizeE164,
|
|
SignalConfigSchema,
|
|
type ChannelPlugin,
|
|
} from "./runtime-api.js";
|
|
import { createSignalSetupWizardProxy } from "./setup-core.js";
|
|
|
|
export const SIGNAL_CHANNEL = "signal" as const;
|
|
|
|
async function loadSignalChannelRuntime() {
|
|
return await import("./channel.runtime.js");
|
|
}
|
|
|
|
export const signalSetupWizard = createSignalSetupWizardProxy(
|
|
async () => (await loadSignalChannelRuntime()).signalSetupWizard,
|
|
);
|
|
|
|
export const signalConfigAdapter = createScopedChannelConfigAdapter<ResolvedSignalAccount>({
|
|
sectionKey: SIGNAL_CHANNEL,
|
|
listAccountIds: listSignalAccountIds,
|
|
resolveAccount: (cfg, accountId) => resolveSignalAccount({ cfg, accountId }),
|
|
defaultAccountId: resolveDefaultSignalAccountId,
|
|
clearBaseFields: ["account", "httpUrl", "httpHost", "httpPort", "cliPath", "name"],
|
|
resolveAllowFrom: (account: ResolvedSignalAccount) => account.config.allowFrom,
|
|
formatAllowFrom: (allowFrom) =>
|
|
allowFrom
|
|
.map((entry) => String(entry).trim())
|
|
.filter(Boolean)
|
|
.map((entry) => (entry === "*" ? "*" : normalizeE164(entry.replace(/^signal:/i, ""))))
|
|
.filter(Boolean),
|
|
resolveDefaultTo: (account: ResolvedSignalAccount) => account.config.defaultTo,
|
|
});
|
|
|
|
export const signalResolveDmPolicy = createScopedDmSecurityResolver<ResolvedSignalAccount>({
|
|
channelKey: SIGNAL_CHANNEL,
|
|
resolvePolicy: (account) => account.config.dmPolicy,
|
|
resolveAllowFrom: (account) => account.config.allowFrom,
|
|
policyPathSuffix: "dmPolicy",
|
|
normalizeEntry: (raw) => normalizeE164(raw.replace(/^signal:/i, "").trim()),
|
|
});
|
|
|
|
export const collectSignalSecurityWarnings =
|
|
createAllowlistProviderRestrictSendersWarningCollector<ResolvedSignalAccount>({
|
|
providerConfigPresent: (cfg) => cfg.channels?.signal !== undefined,
|
|
resolveGroupPolicy: (account) => account.config.groupPolicy,
|
|
surface: "Signal groups",
|
|
openScope: "any member",
|
|
groupPolicyPath: "channels.signal.groupPolicy",
|
|
groupAllowFromPath: "channels.signal.groupAllowFrom",
|
|
mentionGated: false,
|
|
});
|
|
|
|
export function createSignalPluginBase(params: {
|
|
setupWizard?: NonNullable<ChannelPlugin<ResolvedSignalAccount>["setupWizard"]>;
|
|
setup: NonNullable<ChannelPlugin<ResolvedSignalAccount>["setup"]>;
|
|
}): Pick<
|
|
ChannelPlugin<ResolvedSignalAccount>,
|
|
| "id"
|
|
| "meta"
|
|
| "setupWizard"
|
|
| "capabilities"
|
|
| "streaming"
|
|
| "reload"
|
|
| "configSchema"
|
|
| "config"
|
|
| "security"
|
|
| "setup"
|
|
> {
|
|
return createChannelPluginBase({
|
|
id: SIGNAL_CHANNEL,
|
|
meta: {
|
|
...getChatChannelMeta(SIGNAL_CHANNEL),
|
|
},
|
|
setupWizard: params.setupWizard,
|
|
capabilities: {
|
|
chatTypes: ["direct", "group"],
|
|
media: true,
|
|
reactions: true,
|
|
},
|
|
streaming: {
|
|
blockStreamingCoalesceDefaults: { minChars: 1500, idleMs: 1000 },
|
|
},
|
|
reload: { configPrefixes: ["channels.signal"] },
|
|
configSchema: buildChannelConfigSchema(SignalConfigSchema),
|
|
config: {
|
|
...signalConfigAdapter,
|
|
isConfigured: (account) => account.configured,
|
|
describeAccount: (account) => ({
|
|
accountId: account.accountId,
|
|
name: account.name,
|
|
enabled: account.enabled,
|
|
configured: account.configured,
|
|
baseUrl: account.baseUrl,
|
|
}),
|
|
},
|
|
security: {
|
|
resolveDmPolicy: signalResolveDmPolicy,
|
|
collectWarnings: collectSignalSecurityWarnings,
|
|
},
|
|
setup: params.setup,
|
|
}) as Pick<
|
|
ChannelPlugin<ResolvedSignalAccount>,
|
|
| "id"
|
|
| "meta"
|
|
| "setupWizard"
|
|
| "capabilities"
|
|
| "streaming"
|
|
| "reload"
|
|
| "configSchema"
|
|
| "config"
|
|
| "security"
|
|
| "setup"
|
|
>;
|
|
}
|