feat: refine providers onboarding and cli

This commit is contained in:
Peter Steinberger
2026-01-08 06:25:01 +01:00
parent f2557d5390
commit b50ea3ec59
14 changed files with 705 additions and 261 deletions

View File

@@ -0,0 +1,29 @@
import { describe, expect, it } from "vitest";
import {
formatProviderSelectionLine,
listChatProviders,
normalizeChatProviderId,
} from "./registry.js";
describe("provider registry", () => {
it("normalizes aliases", () => {
expect(normalizeChatProviderId("imsg")).toBe("imessage");
});
it("keeps Telegram first in the default order", () => {
const providers = listChatProviders();
expect(providers[0]?.id).toBe("telegram");
});
it("formats selection lines with docs labels", () => {
const providers = listChatProviders();
const first = providers[0];
if (!first) throw new Error("Missing provider metadata.");
const line = formatProviderSelectionLine(first, (path, label) =>
[label, path].filter(Boolean).join(":"),
);
expect(line).toContain("Docs:");
expect(line).toContain("telegram");
});
});

109
src/providers/registry.ts Normal file
View File

@@ -0,0 +1,109 @@
export const CHAT_PROVIDER_ORDER = [
"telegram",
"whatsapp",
"discord",
"slack",
"signal",
"imessage",
] as const;
export type ChatProviderId = (typeof CHAT_PROVIDER_ORDER)[number];
export type ChatProviderMeta = {
id: ChatProviderId;
label: string;
selectionLabel: string;
docsPath: string;
docsLabel?: string;
blurb: string;
};
const CHAT_PROVIDER_META: Record<ChatProviderId, ChatProviderMeta> = {
telegram: {
id: "telegram",
label: "Telegram",
selectionLabel: "Telegram (Bot API)",
docsPath: "/telegram",
docsLabel: "telegram",
blurb:
"simplest way to get started — register a bot with @BotFather and get going.",
},
whatsapp: {
id: "whatsapp",
label: "WhatsApp",
selectionLabel: "WhatsApp (QR link)",
docsPath: "/whatsapp",
docsLabel: "whatsapp",
blurb: "works with your own number; recommend a separate phone + eSIM.",
},
discord: {
id: "discord",
label: "Discord",
selectionLabel: "Discord (Bot API)",
docsPath: "/discord",
docsLabel: "discord",
blurb: "very well supported right now.",
},
slack: {
id: "slack",
label: "Slack",
selectionLabel: "Slack (Socket Mode)",
docsPath: "/slack",
docsLabel: "slack",
blurb: "supported (Socket Mode).",
},
signal: {
id: "signal",
label: "Signal",
selectionLabel: "Signal (signal-cli)",
docsPath: "/signal",
docsLabel: "signal",
blurb:
'signal-cli linked device; more setup (David Reagans: "Hop on Discord.").',
},
imessage: {
id: "imessage",
label: "iMessage",
selectionLabel: "iMessage (imsg)",
docsPath: "/imessage",
docsLabel: "imessage",
blurb: "this is still a work in progress.",
},
};
const CHAT_PROVIDER_ALIASES: Record<string, ChatProviderId> = {
imsg: "imessage",
};
export function listChatProviders(): ChatProviderMeta[] {
return CHAT_PROVIDER_ORDER.map((id) => CHAT_PROVIDER_META[id]);
}
export function getChatProviderMeta(id: ChatProviderId): ChatProviderMeta {
return CHAT_PROVIDER_META[id];
}
export function normalizeChatProviderId(
raw?: string | null,
): ChatProviderId | null {
const trimmed = (raw ?? "").trim().toLowerCase();
if (!trimmed) return null;
const normalized = CHAT_PROVIDER_ALIASES[trimmed] ?? trimmed;
return CHAT_PROVIDER_ORDER.includes(normalized as ChatProviderId)
? (normalized as ChatProviderId)
: null;
}
export function formatProviderPrimerLine(meta: ChatProviderMeta): string {
return `${meta.label}: ${meta.blurb}`;
}
export function formatProviderSelectionLine(
meta: ChatProviderMeta,
docsLink: (path: string, label?: string) => string,
): string {
return `${meta.label}${meta.blurb} Docs: ${docsLink(
meta.docsPath,
meta.docsLabel ?? meta.id,
)}`;
}