* refactor: introduce provider plugin registry * refactor: move provider CLI to plugins * docs: add provider plugin implementation notes * refactor: shift provider runtime logic into plugins * refactor: add plugin defaults and summaries * docs: update provider plugin notes * feat(commands): add /commands slash list * Auto-reply: tidy help message * Auto-reply: fix status command lint * Tests: align google shared expectations * Auto-reply: tidy help message * Auto-reply: fix status command lint * refactor: move provider routing into plugins * test: align agent routing expectations * docs: update provider plugin notes * refactor: route replies via provider plugins * docs: note route-reply plugin hooks * refactor: extend provider plugin contract * refactor: derive provider status from plugins * refactor: unify gateway provider control * refactor: use plugin metadata in auto-reply * fix: parenthesize cron target selection * refactor: derive gateway methods from plugins * refactor: generalize provider logout * refactor: route provider logout through plugins * refactor: move WhatsApp web login methods into plugin * refactor: generalize provider log prefixes * refactor: centralize default chat provider * refactor: derive provider lists from registry * refactor: move provider reload noops into plugins * refactor: resolve web login provider via alias * refactor: derive CLI provider options from plugins * refactor: derive prompt provider list from plugins * style: apply biome lint fixes * fix: resolve provider routing edge cases * docs: update provider plugin refactor notes * fix(gateway): harden agent provider routing * refactor: move provider routing into plugins * refactor: move provider CLI to plugins * refactor: derive provider lists from registry * fix: restore slash command parsing * refactor: align provider ids for schema * refactor: unify outbound target resolution * fix: keep outbound labels stable * feat: add msteams to cron surfaces * fix: clean up lint build issues * refactor: localize chat provider alias normalization * refactor: drive gateway provider lists from plugins * docs: update provider plugin notes * style: format message-provider * fix: avoid provider registry init cycles * style: sort message-provider imports * fix: relax provider alias map typing * refactor: move provider routing into plugins * refactor: add plugin pairing/config adapters * refactor: route pairing and provider removal via plugins * refactor: align auto-reply provider typing * test: stabilize telegram media mocks * docs: update provider plugin refactor notes * refactor: pluginize outbound targets * refactor: pluginize provider selection * refactor: generalize text chunk limits * docs: update provider plugin notes * refactor: generalize group session/config * fix: normalize provider id for room detection * fix: avoid provider init in system prompt * style: formatting cleanup * refactor: normalize agent delivery targets * test: update outbound delivery labels * chore: fix lint regressions * refactor: extend provider plugin adapters * refactor: move elevated/block streaming defaults to plugins * refactor: defer outbound send deps to plugins * docs: note plugin-driven streaming/elevated defaults * refactor: centralize webchat provider constant * refactor: add provider setup adapters * refactor: delegate provider add config to plugins * docs: document plugin-driven provider add * refactor: add plugin state/binding metadata * refactor: build agent provider status from plugins * docs: note plugin-driven agent bindings * refactor: centralize internal provider constant usage * fix: normalize WhatsApp targets for groups and E.164 (#631) (thanks @imfing) * refactor: centralize default chat provider * refactor: centralize WhatsApp target normalization * refactor: move provider routing into plugins * refactor: normalize agent delivery targets * chore: fix lint regressions * fix: normalize WhatsApp targets for groups and E.164 (#631) (thanks @imfing) * feat: expand provider plugin adapters * refactor: route auto-reply via provider plugins * fix: align WhatsApp target normalization * fix: normalize WhatsApp targets for groups and E.164 (#631) (thanks @imfing) * refactor: centralize WhatsApp target normalization * feat: add /config chat config updates * docs: add /config get alias * feat(commands): add /commands slash list * refactor: centralize default chat provider * style: apply biome lint fixes * chore: fix lint regressions * fix: clean up whatsapp allowlist typing * style: format config command helpers * refactor: pluginize tool threading context * refactor: normalize session announce targets * docs: note new plugin threading and announce hooks * refactor: pluginize message actions * docs: update provider plugin actions notes * fix: align provider action adapters * refactor: centralize webchat checks * style: format message provider helpers * refactor: move provider onboarding into adapters * docs: note onboarding provider adapters * feat: add msteams onboarding adapter * style: organize onboarding imports * fix: normalize msteams allowFrom types * feat: add plugin text chunk limits * refactor: use plugin chunk limit fallbacks * feat: add provider mention stripping hooks * style: organize provider plugin type imports * refactor: generalize health snapshots * refactor: update macOS health snapshot handling * docs: refresh health snapshot notes * style: format health snapshot updates * refactor: drive security warnings via plugins * docs: note provider security adapter * style: format provider security adapters * refactor: centralize provider account defaults * refactor: type gateway client identity constants * chore: regen gateway protocol swift * fix: degrade health on failed provider probe * refactor: centralize pairing approve hint * docs: add plugin CLI command references * refactor: route auth and tool sends through plugins * docs: expand provider plugin hooks * refactor: document provider docking touchpoints * refactor: normalize internal provider defaults * refactor: streamline outbound delivery wiring * refactor: make provider onboarding plugin-owned * refactor: support provider-owned agent tools * refactor: move telegram draft chunking into telegram module * refactor: infer provider tool sends via extractToolSend * fix: repair plugin onboarding imports * refactor: de-dup outbound target normalization * style: tidy plugin and agent imports * refactor: data-drive provider selection line * fix: satisfy lint after provider plugin rebase * test: deflake gateway-cli coverage * style: format gateway-cli coverage test * refactor(provider-plugins): simplify provider ids * test(pairing-cli): avoid provider-specific ternary * style(macos): swiftformat HealthStore * refactor(sandbox): derive provider tool denylist * fix(sandbox): avoid plugin init in defaults * refactor(provider-plugins): centralize provider aliases * style(test): satisfy biome * refactor(protocol): v3 providers.status maps * refactor(ui): adapt to protocol v3 * refactor(macos): adapt to protocol v3 * test: update providers.status v3 fixtures * refactor(gateway): map provider runtime snapshot * test(gateway): update reload runtime snapshot * refactor(whatsapp): normalize heartbeat provider id * docs(refactor): update provider plugin notes * style: satisfy biome after rebase * fix: describe sandboxed elevated in prompt * feat(gateway): add agent image attachments + live probe * refactor: derive CLI provider options from plugins * fix(gateway): harden agent provider routing * fix(gateway): harden agent provider routing * refactor: align provider ids for schema * fix(protocol): keep agent provider string * fix(gateway): harden agent provider routing * fix(protocol): keep agent provider string * refactor: normalize agent delivery targets * refactor: support provider-owned agent tools * refactor(config): provider-keyed elevated allowFrom * style: satisfy biome * fix(gateway): appease provider narrowing * style: satisfy biome * refactor(reply): move group intro hints into plugin * fix(reply): avoid plugin registry init cycle * refactor(providers): add lightweight provider dock * refactor(gateway): use typed client id in connect * refactor(providers): document docks and avoid init cycles * refactor(providers): make media limit helper generic * fix(providers): break plugin registry import cycles * style: satisfy biome * refactor(status-all): build providers table from plugins * refactor(gateway): delegate web login to provider plugin * refactor(provider): drop web alias * refactor(provider): lazy-load monitors * style: satisfy lint/format * style: format status-all providers table * style: swiftformat gateway discovery model * test: make reload plan plugin-driven * fix: avoid token stringification in status-all * refactor: make provider IDs explicit in status * feat: warn on signal/imessage provider runtime errors * test: cover gateway provider runtime warnings in status * fix: add runtime kind to provider status issues * test: cover health degradation on probe failure * fix: keep routeReply lightweight * style: organize routeReply imports * refactor(web): extract auth-store helpers * refactor(whatsapp): lazy login imports * refactor(outbound): route replies via plugin outbound * docs: update provider plugin notes * style: format provider status issues * fix: make sandbox scope warning wrap-safe * refactor: load outbound adapters from provider plugins * docs: update provider plugin outbound notes * style(macos): fix swiftformat lint * docs: changelog for provider plugins * fix(macos): satisfy swiftformat * fix(macos): open settings via menu action * style: format after rebase * fix(macos): open Settings via menu action --------- Co-authored-by: LK <luke@kyohere.com> Co-authored-by: Luke K (pr-0f3t) <2609441+lc0rp@users.noreply.github.com> Co-authored-by: Xin <xin@imfing.com>
306 lines
9.2 KiB
TypeScript
306 lines
9.2 KiB
TypeScript
import { randomUUID } from "node:crypto";
|
|
import fsSync from "node:fs";
|
|
import {
|
|
DisconnectReason,
|
|
fetchLatestBaileysVersion,
|
|
makeCacheableSignalKeyStore,
|
|
makeWASocket,
|
|
useMultiFileAuthState,
|
|
} from "@whiskeysockets/baileys";
|
|
import qrcode from "qrcode-terminal";
|
|
import { danger, success } from "../globals.js";
|
|
import { getChildLogger, toPinoLikeLogger } from "../logging.js";
|
|
import { ensureDir, resolveUserPath } from "../utils.js";
|
|
import { VERSION } from "../version.js";
|
|
|
|
import {
|
|
maybeRestoreCredsFromBackup,
|
|
resolveDefaultWebAuthDir,
|
|
resolveWebCredsBackupPath,
|
|
resolveWebCredsPath,
|
|
} from "./auth-store.js";
|
|
|
|
export {
|
|
getWebAuthAgeMs,
|
|
logoutWeb,
|
|
logWebSelfId,
|
|
pickProvider,
|
|
readWebSelfId,
|
|
WA_WEB_AUTH_DIR,
|
|
webAuthExists,
|
|
} from "./auth-store.js";
|
|
|
|
let credsSaveQueue: Promise<void> = Promise.resolve();
|
|
function enqueueSaveCreds(
|
|
authDir: string,
|
|
saveCreds: () => Promise<void> | void,
|
|
logger: ReturnType<typeof getChildLogger>,
|
|
): void {
|
|
credsSaveQueue = credsSaveQueue
|
|
.then(() => safeSaveCreds(authDir, saveCreds, logger))
|
|
.catch((err) => {
|
|
logger.warn({ error: String(err) }, "WhatsApp creds save queue error");
|
|
});
|
|
}
|
|
|
|
function readCredsJsonRaw(filePath: string): string | null {
|
|
try {
|
|
if (!fsSync.existsSync(filePath)) return null;
|
|
const stats = fsSync.statSync(filePath);
|
|
if (!stats.isFile() || stats.size <= 1) return null;
|
|
return fsSync.readFileSync(filePath, "utf-8");
|
|
} catch {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
async function safeSaveCreds(
|
|
authDir: string,
|
|
saveCreds: () => Promise<void> | void,
|
|
logger: ReturnType<typeof getChildLogger>,
|
|
): Promise<void> {
|
|
try {
|
|
// Best-effort backup so we can recover after abrupt restarts.
|
|
// Important: don't clobber a good backup with a corrupted/truncated creds.json.
|
|
const credsPath = resolveWebCredsPath(authDir);
|
|
const backupPath = resolveWebCredsBackupPath(authDir);
|
|
const raw = readCredsJsonRaw(credsPath);
|
|
if (raw) {
|
|
try {
|
|
JSON.parse(raw);
|
|
fsSync.copyFileSync(credsPath, backupPath);
|
|
} catch {
|
|
// keep existing backup
|
|
}
|
|
}
|
|
} catch {
|
|
// ignore backup failures
|
|
}
|
|
try {
|
|
await Promise.resolve(saveCreds());
|
|
} catch (err) {
|
|
logger.warn({ error: String(err) }, "failed saving WhatsApp creds");
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Create a Baileys socket backed by the multi-file auth store we keep on disk.
|
|
* Consumers can opt into QR printing for interactive login flows.
|
|
*/
|
|
export async function createWaSocket(
|
|
printQr: boolean,
|
|
verbose: boolean,
|
|
opts: { authDir?: string; onQr?: (qr: string) => void } = {},
|
|
) {
|
|
const baseLogger = getChildLogger(
|
|
{ module: "baileys" },
|
|
{
|
|
level: verbose ? "info" : "silent",
|
|
},
|
|
);
|
|
const logger = toPinoLikeLogger(baseLogger, verbose ? "info" : "silent");
|
|
const authDir = resolveUserPath(opts.authDir ?? resolveDefaultWebAuthDir());
|
|
await ensureDir(authDir);
|
|
const sessionLogger = getChildLogger({ module: "web-session" });
|
|
maybeRestoreCredsFromBackup(authDir);
|
|
const { state, saveCreds } = await useMultiFileAuthState(authDir);
|
|
const { version } = await fetchLatestBaileysVersion();
|
|
const sock = makeWASocket({
|
|
auth: {
|
|
creds: state.creds,
|
|
keys: makeCacheableSignalKeyStore(state.keys, logger),
|
|
},
|
|
version,
|
|
logger,
|
|
printQRInTerminal: false,
|
|
browser: ["clawdbot", "cli", VERSION],
|
|
syncFullHistory: false,
|
|
markOnlineOnConnect: false,
|
|
});
|
|
|
|
sock.ev.on("creds.update", () =>
|
|
enqueueSaveCreds(authDir, saveCreds, sessionLogger),
|
|
);
|
|
sock.ev.on(
|
|
"connection.update",
|
|
(update: Partial<import("@whiskeysockets/baileys").ConnectionState>) => {
|
|
try {
|
|
const { connection, lastDisconnect, qr } = update;
|
|
if (qr) {
|
|
opts.onQr?.(qr);
|
|
if (printQr) {
|
|
console.log("Scan this QR in WhatsApp (Linked Devices):");
|
|
qrcode.generate(qr, { small: true });
|
|
}
|
|
}
|
|
if (connection === "close") {
|
|
const status = getStatusCode(lastDisconnect?.error);
|
|
if (status === DisconnectReason.loggedOut) {
|
|
console.error(
|
|
danger(
|
|
"WhatsApp session logged out. Run: clawdbot providers login",
|
|
),
|
|
);
|
|
}
|
|
}
|
|
if (connection === "open" && verbose) {
|
|
console.log(success("WhatsApp Web connected."));
|
|
}
|
|
} catch (err) {
|
|
sessionLogger.error(
|
|
{ error: String(err) },
|
|
"connection.update handler error",
|
|
);
|
|
}
|
|
},
|
|
);
|
|
|
|
// Handle WebSocket-level errors to prevent unhandled exceptions from crashing the process
|
|
if (
|
|
sock.ws &&
|
|
typeof (sock.ws as unknown as { on?: unknown }).on === "function"
|
|
) {
|
|
sock.ws.on("error", (err: Error) => {
|
|
sessionLogger.error({ error: String(err) }, "WebSocket error");
|
|
});
|
|
}
|
|
|
|
return sock;
|
|
}
|
|
|
|
export async function waitForWaConnection(
|
|
sock: ReturnType<typeof makeWASocket>,
|
|
) {
|
|
return new Promise<void>((resolve, reject) => {
|
|
type OffCapable = {
|
|
off?: (event: string, listener: (...args: unknown[]) => void) => void;
|
|
};
|
|
const evWithOff = sock.ev as unknown as OffCapable;
|
|
|
|
const handler = (...args: unknown[]) => {
|
|
const update = (args[0] ?? {}) as Partial<
|
|
import("@whiskeysockets/baileys").ConnectionState
|
|
>;
|
|
if (update.connection === "open") {
|
|
evWithOff.off?.("connection.update", handler);
|
|
resolve();
|
|
}
|
|
if (update.connection === "close") {
|
|
evWithOff.off?.("connection.update", handler);
|
|
reject(update.lastDisconnect ?? new Error("Connection closed"));
|
|
}
|
|
};
|
|
|
|
sock.ev.on("connection.update", handler);
|
|
});
|
|
}
|
|
|
|
export function getStatusCode(err: unknown) {
|
|
return (
|
|
(err as { output?: { statusCode?: number } })?.output?.statusCode ??
|
|
(err as { status?: number })?.status
|
|
);
|
|
}
|
|
|
|
function safeStringify(value: unknown, limit = 800): string {
|
|
try {
|
|
const seen = new WeakSet<object>();
|
|
const raw = JSON.stringify(
|
|
value,
|
|
(_key, v) => {
|
|
if (typeof v === "bigint") return v.toString();
|
|
if (typeof v === "function") {
|
|
const maybeName = (v as { name?: unknown }).name;
|
|
const name =
|
|
typeof maybeName === "string" && maybeName.length > 0
|
|
? maybeName
|
|
: "anonymous";
|
|
return `[Function ${name}]`;
|
|
}
|
|
if (typeof v === "object" && v) {
|
|
if (seen.has(v)) return "[Circular]";
|
|
seen.add(v);
|
|
}
|
|
return v;
|
|
},
|
|
2,
|
|
);
|
|
if (!raw) return String(value);
|
|
return raw.length > limit ? `${raw.slice(0, limit)}…` : raw;
|
|
} catch {
|
|
return String(value);
|
|
}
|
|
}
|
|
|
|
function extractBoomDetails(err: unknown): {
|
|
statusCode?: number;
|
|
error?: string;
|
|
message?: string;
|
|
} | null {
|
|
if (!err || typeof err !== "object") return null;
|
|
const output = (err as { output?: unknown })?.output as
|
|
| { statusCode?: unknown; payload?: unknown }
|
|
| undefined;
|
|
if (!output || typeof output !== "object") return null;
|
|
const payload = (output as { payload?: unknown }).payload as
|
|
| { error?: unknown; message?: unknown; statusCode?: unknown }
|
|
| undefined;
|
|
const statusCode =
|
|
typeof (output as { statusCode?: unknown }).statusCode === "number"
|
|
? ((output as { statusCode?: unknown }).statusCode as number)
|
|
: typeof payload?.statusCode === "number"
|
|
? (payload.statusCode as number)
|
|
: undefined;
|
|
const error = typeof payload?.error === "string" ? payload.error : undefined;
|
|
const message =
|
|
typeof payload?.message === "string" ? payload.message : undefined;
|
|
if (!statusCode && !error && !message) return null;
|
|
return { statusCode, error, message };
|
|
}
|
|
|
|
export function formatError(err: unknown): string {
|
|
if (err instanceof Error) return err.message;
|
|
if (typeof err === "string") return err;
|
|
if (!err || typeof err !== "object") return String(err);
|
|
|
|
// Baileys frequently wraps errors under `error` with a Boom-like shape.
|
|
const boom =
|
|
extractBoomDetails(err) ??
|
|
extractBoomDetails((err as { error?: unknown })?.error) ??
|
|
extractBoomDetails(
|
|
(err as { lastDisconnect?: { error?: unknown } })?.lastDisconnect?.error,
|
|
);
|
|
|
|
const status = boom?.statusCode ?? getStatusCode(err);
|
|
const code = (err as { code?: unknown })?.code;
|
|
const codeText =
|
|
typeof code === "string" || typeof code === "number"
|
|
? String(code)
|
|
: undefined;
|
|
|
|
const messageCandidates = [
|
|
boom?.message,
|
|
typeof (err as { message?: unknown })?.message === "string"
|
|
? ((err as { message?: unknown }).message as string)
|
|
: undefined,
|
|
typeof (err as { error?: { message?: unknown } })?.error?.message ===
|
|
"string"
|
|
? ((err as { error?: { message?: unknown } }).error?.message as string)
|
|
: undefined,
|
|
].filter((v): v is string => Boolean(v && v.trim().length > 0));
|
|
const message = messageCandidates[0];
|
|
|
|
const pieces: string[] = [];
|
|
if (typeof status === "number") pieces.push(`status=${status}`);
|
|
if (boom?.error) pieces.push(boom.error);
|
|
if (message) pieces.push(message);
|
|
if (codeText) pieces.push(`code=${codeText}`);
|
|
|
|
if (pieces.length > 0) return pieces.join(" ");
|
|
return safeStringify(err);
|
|
}
|
|
|
|
export function newConnectionId() {
|
|
return randomUUID();
|
|
}
|