@stage-labs/metro 0.1.0-beta.13 → 0.1.0-beta.131

package/runtime/node_modules/@metro-labs/discord-bot/src/members.ts

@@ -0,0 +1,215 @@
+import { errMsg } from '@metro-labs/core/log';
+import type { MemberList, MetroMember } from '@metro-labs/core/stations/types';
+import { rest } from './accounts.js';
+
+export interface DiscordRole {
+  id: string;
+  name: string;
+  permissions: string;
+}
+
+export interface DiscordUser {
+  id: string;
+  username?: string;
+  global_name?: string | null;
+  bot?: boolean;
+}
+
+export interface DiscordGuildMember {
+  user?: DiscordUser;
+  nick?: string | null;
+  roles?: string[];
+}
+
+const ADMINISTRATOR = 1n << 3n;
+const PAGE = 1000;
+
+export interface RoleInfo {
+  name: string;
+  admin: boolean;
+}
+
+function roleIsAdmin(permissions: string): boolean {
+  try {
+    return (BigInt(permissions) & ADMINISTRATOR) === ADMINISTRATOR;
+  } catch {
+    return false;
+  }
+}
+
+export function indexRoles(roles: DiscordRole[]): Map<string, RoleInfo> {
+  const out = new Map<string, RoleInfo>();
+  for (const r of roles)
+    out.set(r.id, { name: r.name, admin: roleIsAdmin(r.permissions) });
+  return out;
+}
+
+function isAdmin(
+  userId: string,
+  roleIds: string[],
+  roles: Map<string, RoleInfo>,
+  ownerId?: string,
+): boolean {
+  if (ownerId !== undefined && userId === ownerId) return true;
+  return roleIds.some((id) => roles.get(id)?.admin === true);
+}
+
+export function mapGuildMember(
+  m: DiscordGuildMember,
+  roles: Map<string, RoleInfo>,
+  ownerId?: string,
+): MetroMember | null {
+  const user = m.user;
+  if (!user?.id) return null;
+  const member: MetroMember = { id: user.id };
+  if (user.username) member.name = user.username;
+  const display = m.nick ?? user.global_name ?? undefined;
+  if (display) member.display_name = display;
+  const roleIds = m.roles ?? [];
+  const roleNames = roleIds
+    .map((id) => roles.get(id)?.name)
+    .filter((n): n is string => Boolean(n));
+  if (roleNames.length) member.roles = roleNames;
+  member.is_admin = isAdmin(user.id, roleIds, roles, ownerId);
+  member.is_bot = Boolean(user.bot);
+  return member;
+}
+
+export function mapGuildMembers(
+  members: DiscordGuildMember[],
+  roles: Map<string, RoleInfo>,
+  ownerId?: string,
+): MetroMember[] {
+  return members
+    .map((m) => mapGuildMember(m, roles, ownerId))
+    .filter((x): x is MetroMember => x !== null);
+}
+
+export function mapRecipients(users: DiscordUser[]): MetroMember[] {
+  return users
+    .filter((u) => Boolean(u?.id))
+    .map((u) => {
+      const m: MetroMember = { id: u.id };
+      if (u.username) m.name = u.username;
+      if (u.global_name) m.display_name = u.global_name;
+      m.is_bot = Boolean(u.bot);
+      return m;
+    });
+}
+
+async function fetchRoles(
+  accountId: string,
+  guildId: string,
+): Promise<Map<string, RoleInfo>> {
+  try {
+    const roles = await rest<DiscordRole[]>(
+      accountId,
+      'GET',
+      `/guilds/${guildId}/roles`,
+    );
+    return indexRoles(roles);
+  } catch {
+    return new Map();
+  }
+}
+
+async function fetchOwnerId(
+  accountId: string,
+  guildId: string,
+): Promise<string | undefined> {
+  try {
+    const g = await rest<{ owner_id?: string }>(
+      accountId,
+      'GET',
+      `/guilds/${guildId}`,
+    );
+    return g.owner_id;
+  } catch {
+    return undefined;
+  }
+}
+
+interface Collected {
+  raw: DiscordGuildMember[];
+  exhausted: boolean;
+}
+
+async function paginate(
+  accountId: string,
+  guildId: string,
+  cap: number,
+): Promise<Collected> {
+  const raw: DiscordGuildMember[] = [];
+  let after: string | undefined;
+  for (;;) {
+    const want = Math.min(PAGE, cap - raw.length);
+    if (want <= 0) return { raw, exhausted: false };
+    const qs = new URLSearchParams({ limit: String(want) });
+    if (after) qs.set('after', after);
+    const page = await rest<DiscordGuildMember[]>(
+      accountId,
+      'GET',
+      `/guilds/${guildId}/members?${qs}`,
+    );
+    raw.push(...page);
+    if (page.length < want) return { raw, exhausted: true };
+    after = page[page.length - 1]?.user?.id;
+    if (!after) return { raw, exhausted: true };
+  }
+}
+
+const INTENT_HINT =
+  'Discord bot lacks the privileged GUILD_MEMBERS intent (enable it in the ' +
+  'Developer Portal) or channel access; returning what is reachable.';
+
+export async function listGuildMembers(
+  accountId: string,
+  guildId: string,
+  limit?: number,
+): Promise<MemberList> {
+  const cap = Math.min(Math.max(1, limit ?? PAGE), 10_000);
+  const roles = await fetchRoles(accountId, guildId);
+  const ownerId = await fetchOwnerId(accountId, guildId);
+  try {
+    const { raw, exhausted } = await paginate(accountId, guildId, cap);
+    const members = mapGuildMembers(raw, roles, ownerId);
+    return {
+      members,
+      capability: exhausted
+        ? { supported: true, complete: true, total: members.length }
+        : {
+            supported: true,
+            complete: false,
+            reason: `truncated at limit ${cap}`,
+          },
+    };
+  } catch (e) {
+    const msg = errMsg(e);
+    if (/\b40[13]\b/.test(msg))
+      return {
+        members: [],
+        capability: { supported: false, complete: false, reason: INTENT_HINT },
+      };
+    throw e;
+  }
+}
+
+export async function discordMembers(
+  accountId: string,
+  channelId: string,
+  limit?: number,
+): Promise<MemberList> {
+  const chan = await rest<{ guild_id?: string; recipients?: DiscordUser[] }>(
+    accountId,
+    'GET',
+    `/channels/${channelId}`,
+  );
+  if (!chan.guild_id) {
+    const members = mapRecipients(chan.recipients ?? []);
+    return {
+      members,
+      capability: { supported: true, complete: true, total: members.length },
+    };
+  }
+  return listGuildMembers(accountId, chan.guild_id, limit);
+}

package/runtime/node_modules/@metro-labs/discord-bot/src/send-files.ts

@@ -0,0 +1,43 @@
+import { appendFile } from '@metro-labs/core/stations/attachments';
+
+export interface OutgoingFile {
+  path: string;
+  name: string;
+  kind: string;
+}
+
+const basenameOf = (path: string, index: number): string =>
+  path.split('/').pop() ?? `file-${index}`;
+
+export function outgoingFiles(
+  paths: string[],
+  names: string[] | undefined,
+  kinds: string[] | undefined,
+): OutgoingFile[] {
+  const out: OutgoingFile[] = [];
+  for (let i = 0; i < paths.length; i++) {
+    const path = paths[i];
+    if (path === undefined || path === '') continue;
+    const given = names?.[i];
+    out.push({
+      path,
+      name: given !== undefined && given !== '' ? given : basenameOf(path, i),
+      kind: kinds?.[i] ?? 'file',
+    });
+  }
+  return out;
+}
+
+export async function appendFiles(
+  form: FormData,
+  files: OutgoingFile[],
+): Promise<string[]> {
+  const delivered: string[] = [];
+  for (let i = 0; i < files.length; i++) {
+    const file = files[i];
+    if (!file) continue;
+    await appendFile(form, `files[${i}]`, file.path, file.name);
+    delivered.push(file.kind);
+  }
+  return delivered;
+}

package/runtime/node_modules/@metro-labs/discord-bot/src/station.ts

@@ -0,0 +1,19 @@
+import type { GroupOp, Station, Verb } from '@metro-labs/core/stations/types';
+
+export const discordBotStation: Station = {
+  name: 'discord-bot',
+  hasAccounts: true,
+  hasTrain: true,
+  messageVerbs: new Set<Verb>([
+    'send',
+    'reply',
+    'react',
+    'unreact',
+    'edit',
+    'delete',
+    'read',
+  ]),
+  groupOps: new Set<GroupOp>(['create_group', 'add_members', 'remove_members']),
+  attachmentMode: 'canonical',
+  tools: [],
+};

package/runtime/node_modules/@metro-labs/discord-bot/src/verify.ts

@@ -0,0 +1,82 @@
+import { API } from './api-base.js';
+
+export class DiscordTokenError extends Error {}
+
+export interface DiscordBotIdentity {
+  userId: string;
+  username: string;
+  messageContent: boolean;
+}
+
+const MESSAGE_CONTENT = 1 << 18;
+const MESSAGE_CONTENT_LIMITED = 1 << 19;
+const TIMEOUT_MS = 10_000;
+
+function botFetch(token: string, path: string): Promise<Response> {
+  return fetch(`${API}${path}`, {
+    headers: {
+      authorization: `Bot ${token}`,
+      'user-agent': 'metro-daemon (https://github.com/bonustrack/metro)',
+    },
+    signal: AbortSignal.timeout(TIMEOUT_MS),
+  });
+}
+
+async function readJson(res: Response): Promise<Record<string, unknown>> {
+  try {
+    const body: unknown = await res.json();
+    return typeof body === 'object' && body !== null
+      ? (body as Record<string, unknown>)
+      : {};
+  } catch {
+    throw new DiscordTokenError('Discord returned a response Metro could not read');
+  }
+}
+
+async function selfUser(token: string): Promise<Record<string, unknown>> {
+  let res: Response;
+  try {
+    res = await botFetch(token, '/users/@me');
+  } catch {
+    throw new DiscordTokenError(
+      'could not reach the Discord API to check that bot token',
+    );
+  }
+  if (res.status === 401 || res.status === 403)
+    throw new DiscordTokenError('Discord rejected that bot token');
+  if (!res.ok)
+    throw new DiscordTokenError(
+      `Discord answered ${res.status} while checking that bot token`,
+    );
+  return readJson(res);
+}
+
+async function messageContentEnabled(token: string): Promise<boolean> {
+  try {
+    const res = await botFetch(token, '/applications/@me');
+    if (!res.ok) return true;
+    const flags = (await readJson(res)).flags;
+    if (typeof flags !== 'number') return true;
+    return (flags & (MESSAGE_CONTENT | MESSAGE_CONTENT_LIMITED)) !== 0;
+  } catch {
+    return true;
+  }
+}
+
+export async function verifyDiscordBotToken(
+  token: string,
+): Promise<DiscordBotIdentity> {
+  const me = await selfUser(token);
+  const userId = typeof me.id === 'string' ? me.id : '';
+  if (userId === '')
+    throw new DiscordTokenError('Discord returned no bot identity for that token');
+  if (me.bot !== true)
+    throw new DiscordTokenError(
+      'that token belongs to a Discord user, not a bot application',
+    );
+  return {
+    userId,
+    username: typeof me.username === 'string' ? me.username : '',
+    messageContent: await messageContentEnabled(token),
+  };
+}

package/runtime/node_modules/@metro-labs/discord-bot/src/voice-speak.ts

@@ -0,0 +1,195 @@
+import { errMsg } from '@metro-labs/core/log';
+import { spawn } from 'node:child_process';
+import { unlink } from 'node:fs/promises';
+import {
+  createAudioPlayer,
+  createAudioResource,
+  getVoiceConnection,
+  entersState,
+  AudioPlayerStatus,
+  StreamType,
+  NoSubscriberBehavior,
+  type VoiceConnection,
+} from '@discordjs/voice';
+import type { Client } from 'discord.js';
+import { accountFor, accounts, routeOf } from './accounts.js';
+import { respond } from './wire.js';
+
+const TTS_VOICE = 'Samantha';
+
+function clientFor(account?: string): { accountId: string; client: Client } {
+  const accountId = accountFor({ account });
+  const acct = accounts.get(accountId);
+  if (!acct) throw new Error(`unknown account '${accountId}'`);
+  return { accountId, client: acct.client };
+}
+
+function run(cmd: string, args: string[]): Promise<void> {
+  return new Promise((resolve, reject) => {
+    const p = spawn(cmd, args, { stdio: ['ignore', 'ignore', 'pipe'] });
+    let err = '';
+    p.stderr?.on('data', (d: Buffer) => {
+      err += d.toString();
+    });
+    p.on('error', reject);
+    p.on('close', (code) => {
+      if (code === 0) resolve();
+      else reject(new Error(`${cmd} exited ${code}: ${err.slice(-400)}`));
+    });
+  });
+}
+
+function channelName(ch: unknown, fallback: string): string {
+  return ch && typeof ch === 'object' && 'name' in ch
+    ? String((ch as { name?: string }).name)
+    : fallback;
+}
+
+function resolveChannelId(args: {
+  channelId?: string;
+  line?: string;
+  account?: string;
+}): string | undefined {
+  if (args.channelId) return args.channelId;
+  if (!args.line) return undefined;
+  try {
+    return routeOf(args.line, args.account).channelId;
+  } catch {
+    return undefined;
+  }
+}
+
+function connByChannel(
+  client: Client,
+  channelId: string | undefined,
+): { conn: VoiceConnection; channelName: string } | null {
+  if (!channelId) return null;
+  const ch = client.channels.cache.get(channelId);
+  const gid =
+    ch && 'guildId' in ch ? (ch as { guildId: string }).guildId : undefined;
+  if (!gid) return null;
+  const conn = getVoiceConnection(gid);
+  if (!conn) return null;
+  return { conn, channelName: channelName(ch, gid) };
+}
+
+function connByGuildScan(
+  client: Client,
+): { conn: VoiceConnection; channelName: string } | null {
+  for (const guild of client.guilds.cache.values()) {
+    const conn = getVoiceConnection(guild.id);
+    if (conn) {
+      const chId = (conn.joinConfig as { channelId?: string }).channelId;
+      const ch = chId ? client.channels.cache.get(chId) : undefined;
+      return { conn, channelName: channelName(ch, guild.name) };
+    }
+  }
+  return null;
+}
+
+function resolveConnection(
+  client: Client,
+  args: { channelId?: string; line?: string; account?: string },
+): { conn: VoiceConnection; channelName: string } | { error: string } {
+  const channelId = resolveChannelId(args);
+  return (
+    connByChannel(client, channelId) ??
+    connByGuildScan(client) ?? {
+      error: 'no active voice connection — run joinVoice first',
+    }
+  );
+}
+
+export async function speak(
+  id: string,
+  rawArgs: Record<string, unknown>,
+): Promise<void> {
+  const args = rawArgs as {
+    account?: string;
+    text?: string;
+    channelId?: string;
+    line?: string;
+    voice?: string;
+  };
+  const text = (args.text ?? '').trim();
+  if (!text) {
+    respond(id, { result: { ok: false, error: 'text is required' } });
+    return;
+  }
+
+  const { accountId, client } = clientFor(args.account);
+  if (!client.isReady()) {
+    respond(id, {
+      result: { ok: false, error: `gateway not ready for '${accountId}'` },
+    });
+    return;
+  }
+
+  const resolved = resolveConnection(client, args);
+  if ('error' in resolved) {
+    respond(id, { result: { ok: false, error: resolved.error } });
+    return;
+  }
+  const { conn, channelName } = resolved;
+
+  const ts = Date.now();
+  const aiff = `/tmp/metro-tts-${ts}.aiff`;
+  const ogg = `/tmp/metro-tts-${ts}.ogg`;
+  const cleanup = async () => {
+    await Promise.allSettled([unlink(aiff), unlink(ogg)]);
+  };
+
+  try {
+    await run('say', ['-v', args.voice ?? TTS_VOICE, '-o', aiff, text]);
+    await run('ffmpeg', [
+      '-hide_banner',
+      '-loglevel',
+      'error',
+      '-y',
+      '-i',
+      aiff,
+      '-ac',
+      '2',
+      '-ar',
+      '48000',
+      '-c:a',
+      'libopus',
+      '-b:a',
+      '64k',
+      '-f',
+      'ogg',
+      ogg,
+    ]);
+
+    const player = createAudioPlayer({
+      behaviors: { noSubscriber: NoSubscriberBehavior.Play },
+    });
+    const resource = createAudioResource(ogg, {
+      inputType: StreamType.OggOpus,
+    });
+    conn.subscribe(player);
+    try {
+      (conn as { rejoin: (c: object) => void }).rejoin({ selfMute: false });
+    } catch {
+    }
+    player.play(resource);
+
+    await entersState(player, AudioPlayerStatus.Playing, 10_000);
+    await entersState(player, AudioPlayerStatus.Idle, 120_000);
+    player.stop();
+    try {
+      (conn as { rejoin: (c: object) => void }).rejoin({ selfMute: true });
+    } catch {
+    }
+
+    respond(id, {
+      result: { ok: true, spoke: text, channelName, account: accountId },
+    });
+  } catch (err) {
+    respond(id, {
+      result: { ok: false, error: errMsg(err), account: accountId },
+    });
+  } finally {
+    await cleanup();
+  }
+}