@stage-labs/metro 0.1.0-beta.3 → 0.1.0-beta.300

package/runtime/node_modules/@metro-labs/threema/src/outbound.ts

@@ -0,0 +1,161 @@
+import { TrainError } from '@metro-labs/core/train-error';
+import { respond } from '@metro-labs/core/stations/station-runtime';
+import { publicKeyFor, targetOf, type Account, type Target } from './accounts.js';
+import { sendE2E } from './api.js';
+import { bytesToHex, quoted, seal } from './crypto.js';
+import { encodeFileFor, fileLabel, packFile, type OutgoingFile } from './files.js';
+import { emitOutbound, emitOutboundReaction } from './format.js';
+import { MESSAGE_ID_RE } from './ids.js';
+import {
+  encodeGroupReaction,
+  encodeGroupSyncRequest,
+  encodeGroupText,
+  encodeReaction,
+  encodeText,
+  type GroupRef,
+} from './messages.js';
+
+export const MAX_TEXT_BYTES = 3500;
+const SENT_MAX = 2000;
+
+type Args = Record<string, unknown>;
+
+const sentIds = new Set<string>();
+
+export function noteSent(messageId: string): void {
+  sentIds.add(messageId);
+  while (sentIds.size > SENT_MAX) {
+    const oldest = sentIds.values().next();
+    if (oldest.done) break;
+    sentIds.delete(oldest.value);
+  }
+}
+
+export const sentByUs = (messageId: string): boolean => sentIds.has(messageId);
+
+async function deliver(acct: Account, to: string, plain: Uint8Array, group: boolean): Promise<string> {
+  const { nonce, box } = seal(plain, await publicKeyFor(acct, to), acct.keys);
+  const messageId = await sendE2E(acct.cfg, to, bytesToHex(nonce), bytesToHex(box), group);
+  noteSent(messageId);
+  if (!group) acct.chats.note(to);
+  return messageId;
+}
+
+function recipientsOf(acct: Account, group: GroupRef): string[] {
+  const members = acct.groups.recipients(group);
+  if (members === null)
+    throw new TrainError(
+      'threema_unknown_group',
+      'metro has not received this group\'s member list yet; it asked the group creator for it, try again in a moment',
+      { retryable: true },
+    );
+  return members;
+}
+
+export async function requestSync(acct: Account, group: GroupRef): Promise<void> {
+  await deliver(acct, group.creator, encodeGroupSyncRequest(group.groupId), true);
+}
+
+async function fanOut(acct: Account, target: Target, direct: Uint8Array, grouped: (g: GroupRef) => Uint8Array): Promise<string[]> {
+  if (target.kind === 'user') return [await deliver(acct, target.id, direct, false)];
+  const ids: string[] = [];
+  for (const member of recipientsOf(acct, target.group)) ids.push(await deliver(acct, member, grouped(target.group), true));
+  if (ids.length === 0) throw new TrainError('threema_empty_group', 'nobody else is in this group', { retryable: false });
+  return ids;
+}
+
+interface SendArgs {
+  line: string;
+  text?: unknown;
+  replyTo?: unknown;
+  account?: string;
+  attachments?: unknown;
+}
+
+const filesOf = (raw: unknown): OutgoingFile[] =>
+  (Array.isArray(raw) ? raw : [])
+    .map((a) => (a ?? {}) as Record<string, unknown>)
+    .filter((a) => typeof a.path === 'string' && a.path !== '')
+    .map((a) => ({ path: String(a.path), mime: typeof a.mime === 'string' && a.mime !== '' ? a.mime : 'application/octet-stream', name: typeof a.name === 'string' && a.name !== '' ? a.name : 'file' }));
+
+function textOf(a: SendArgs, files: OutgoingFile[]): string {
+  const text = typeof a.text === 'string' ? a.text : '';
+  if (text === '' && files.length === 0)
+    throw new TrainError('threema_text_required', 'give some text or a file to send', { retryable: false });
+  return text;
+}
+
+async function sendFiles(acct: Account, target: Target, files: OutgoingFile[], caption: string | null): Promise<{ ids: string[]; labels: string[] }> {
+  const ids: string[] = [];
+  const labels: string[] = [];
+  for (const [i, file] of files.entries()) {
+    const packed = await packFile(acct, file, i === 0 ? caption : null);
+    const sent = await fanOut(acct, target, encodeFileFor(null, packed), (g) => encodeFileFor(g, packed));
+    ids.push(...sent);
+    labels.push(fileLabel(file));
+  }
+  return { ids, labels };
+}
+
+function messageIdOf(raw: unknown, field: string): string {
+  const id = typeof raw === 'string' ? raw.toLowerCase() : '';
+  if (!MESSAGE_ID_RE.test(id))
+    throw new TrainError('threema_bad_message_id', `${field} must be a Threema message id, 16 hex characters`, { retryable: false });
+  return id;
+}
+
+const replyTargetOf = (raw: unknown): string | undefined => (raw === undefined || raw === null || raw === '' ? undefined : messageIdOf(raw, 'replyTo'));
+
+function bodyOf(text: string, replyTo: string | undefined): string {
+  const body = replyTo === undefined ? text : quoted(replyTo, text);
+  if (Buffer.byteLength(body, 'utf8') > MAX_TEXT_BYTES)
+    throw new TrainError('threema_message_too_long', `Threema carries at most ${MAX_TEXT_BYTES} bytes of text per message; split it up`, { retryable: false });
+  return body;
+}
+
+interface Sent {
+  ids: string[];
+  labels: string[];
+}
+
+const resultOf = (acct: Account, sent: Sent): Record<string, unknown> => ({
+  messageId: sent.ids[0] ?? '',
+  account: acct.cfg.id,
+  ...(sent.ids.length > 1 ? { messageIds: sent.ids } : {}),
+  ...(sent.labels.length > 0 ? { attachments: sent.labels } : {}),
+});
+
+export async function send(id: string, args: Args): Promise<void> {
+  const a = args as unknown as SendArgs;
+  const files = filesOf(a.attachments);
+  const text = textOf(a, files);
+  const replyTo = replyTargetOf(a.replyTo);
+  const { acct, target } = targetOf(a.line, a.account);
+  const body = bodyOf(text, replyTo);
+  const sent: Sent =
+    files.length === 0
+      ? { ids: await fanOut(acct, target, encodeText(body), (g) => encodeGroupText(g, body)), labels: [] }
+      : await sendFiles(acct, target, files, body === '' ? null : body);
+  emitOutbound(acct.cfg.id, a.line, sent.ids[0] ?? '', text === '' ? `[${sent.labels.join(', ')}]` : text, replyTo);
+  respond(id, { result: resultOf(acct, sent) });
+}
+
+interface ReactArgs {
+  line: string;
+  messageId?: unknown;
+  emoji?: unknown;
+  account?: string;
+  action?: unknown;
+}
+
+export async function react(id: string, args: Args): Promise<void> {
+  const a = args as unknown as ReactArgs;
+  const emoji = typeof a.emoji === 'string' ? a.emoji.trim() : '';
+  if (emoji === '') throw new TrainError('threema_emoji_required', 'react needs an emoji', { retryable: false });
+  const messageId = messageIdOf(a.messageId, 'messageId');
+  const removed = a.action === 'removed';
+  const { acct, target } = targetOf(a.line, a.account);
+  const ids = await fanOut(acct, target, encodeReaction(messageId, emoji, removed), (g) => encodeGroupReaction(g, messageId, emoji, removed));
+  emitOutboundReaction(acct.cfg.id, a.line, ids[0] ?? '', emoji, messageId, removed);
+  respond(id, { result: { messageId: ids[0] ?? '', account: acct.cfg.id, emoji, removed } });
+}

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

@@ -0,0 +1,21 @@
+import type { Station, Verb } from '@metro-labs/core/stations/types';
+import { groupFiles } from './groups.js';
+import { chatFiles } from './chats.js';
+
+export const threemaStation: Station = {
+  name: 'threema',
+  hasAccounts: true,
+  hasTrain: true,
+  discoversChannels: true,
+  messageVerbs: new Set<Verb>(['send', 'reply', 'react', 'unreact']),
+  attachmentMode: 'canonical',
+  forget(accountId) {
+    groupFiles.forget(accountId);
+    chatFiles.forget(accountId);
+  },
+  forgetExcept(accountIds) {
+    groupFiles.forgetExcept(accountIds);
+    chatFiles.forgetExcept(accountIds);
+  },
+  tools: [],
+};

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

@@ -0,0 +1,117 @@
+import { createPrivateKey, createPublicKey } from 'node:crypto';
+import {
+  GATEWAY_API,
+  isGatewayId,
+  normalizeThreemaId,
+  parsePrivateKey,
+} from './ids.js';
+
+export { parsePrivateKey } from './ids.js';
+
+export class ThreemaGatewayError extends Error {}
+
+export interface ThreemaCredentials {
+  gatewayId: string;
+  secret: string;
+  privateKey: string;
+}
+
+export interface ThreemaGatewayIdentity {
+  gatewayId: string;
+  publicKey: string;
+  credits: number;
+}
+
+const PKCS8_X25519_PREFIX = Buffer.from(
+  '302e020100300506032b656e04220420',
+  'hex',
+);
+const TIMEOUT_MS = 10_000;
+const PUBLIC_KEY_RE = /^[0-9a-f]{64}$/;
+
+export function publicKeyOf(privateKeyHex: string): string {
+  const der = Buffer.concat([
+    PKCS8_X25519_PREFIX,
+    Buffer.from(privateKeyHex, 'hex'),
+  ]);
+  const key = createPrivateKey({ key: der, format: 'der', type: 'pkcs8' });
+  const jwk = createPublicKey(key).export({ format: 'jwk' });
+  return Buffer.from(String(jwk.x), 'base64url').toString('hex');
+}
+
+async function gatewayGet(
+  path: string,
+  gatewayId: string,
+  secret: string,
+): Promise<Response> {
+  const query = new URLSearchParams({ from: gatewayId, secret });
+  try {
+    return await fetch(`${GATEWAY_API}${path}?${query.toString()}`, {
+      signal: AbortSignal.timeout(TIMEOUT_MS),
+    });
+  } catch {
+    throw new ThreemaGatewayError(
+      'could not reach the Threema Gateway to check those credentials',
+    );
+  }
+}
+
+function refused(res: Response, what: string): ThreemaGatewayError {
+  if (res.status === 401)
+    return new ThreemaGatewayError(
+      'Threema rejected that Gateway ID or API secret',
+    );
+  if (res.status === 404)
+    return new ThreemaGatewayError(`Threema does not know ${what}`);
+  return new ThreemaGatewayError(
+    `the Threema Gateway answered ${res.status} while checking ${what}`,
+  );
+}
+
+async function fetchCredits(gatewayId: string, secret: string): Promise<number> {
+  const res = await gatewayGet('/credits', gatewayId, secret);
+  if (!res.ok) throw refused(res, 'the credit balance');
+  const credits = Number((await res.text()).trim());
+  if (!Number.isInteger(credits))
+    throw new ThreemaGatewayError(
+      'the Threema Gateway gave an unexpected answer for the credit balance',
+    );
+  return credits;
+}
+
+async function fetchPublicKey(gatewayId: string, secret: string): Promise<string> {
+  const res = await gatewayGet(
+    `/pubkeys/${encodeURIComponent(gatewayId)}`,
+    gatewayId,
+    secret,
+  );
+  if (!res.ok) throw refused(res, `the public key of ${gatewayId}`);
+  const hex = (await res.text()).trim().toLowerCase();
+  if (!PUBLIC_KEY_RE.test(hex))
+    throw new ThreemaGatewayError(
+      'the Threema Gateway gave an unexpected answer for the public key',
+    );
+  return hex;
+}
+
+export async function verifyThreemaGateway(
+  input: ThreemaCredentials,
+): Promise<ThreemaGatewayIdentity> {
+  const gatewayId = normalizeThreemaId(input.gatewayId);
+  if (!isGatewayId(gatewayId))
+    throw new ThreemaGatewayError(
+      'a Threema Gateway ID is a * followed by 7 letters or digits, as in *ABCDEFG',
+    );
+  const privateKey = parsePrivateKey(input.privateKey);
+  if (privateKey === null)
+    throw new ThreemaGatewayError(
+      'the private key is the 64 hex characters from the key file Threema gave you, with or without its private: prefix',
+    );
+  const credits = await fetchCredits(gatewayId, input.secret);
+  const registered = await fetchPublicKey(gatewayId, input.secret);
+  if (registered !== publicKeyOf(privateKey))
+    throw new ThreemaGatewayError(
+      `that private key does not belong to ${gatewayId}: the Gateway holds a different public key for it`,
+    );
+  return { gatewayId, publicKey: registered, credits };
+}

package/runtime/node_modules/@metro-labs/webhook/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@metro-labs/webhook",
+  "version": "0.1.0",
+  "private": true,
+  "type": "module",
+  "exports": {
+    ".": "./src/station.ts"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "tsc --noEmit && bun test test/"
+  },
+  "dependencies": {
+    "@metro-labs/core": "workspace:*"
+  },
+  "devDependencies": {
+    "@stage-labs/config": "0.1.0-beta.3",
+    "eslint": "^10.3.0",
+    "knip": "^6.15.0",
+    "madge": "^8.0.0",
+    "typescript": "^5"
+  }
+}

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

@@ -0,0 +1,37 @@
+import { randomUUID } from 'node:crypto';
+import { Line } from '@metro-labs/core/lines';
+import { mintId, type MetroEvent } from '@metro-labs/core/events';
+import type { Endpoint } from '@metro-labs/core/endpoints';
+import type { Station, Verb } from '@metro-labs/core/stations/types';
+
+export const webhookStation: Station = {
+  name: 'webhook',
+  hasAccounts: true,
+  hasTrain: false,
+  messageVerbs: new Set<Verb>(),
+  attachmentMode: 'none',
+  tools: [],
+};
+
+export function webhookEntry(
+  endpoint: Endpoint,
+  headers: Record<string, string>,
+  body: unknown,
+  method: string,
+  url: string,
+): MetroEvent {
+  const line = Line.webhook(endpoint.id);
+  return {
+    id: mintId(),
+    ts: new Date().toISOString(),
+    station: 'webhook',
+    line,
+    lineName: endpoint.label,
+    from: line,
+    to: line,
+    messageId:
+      headers['x-github-delivery'] ?? headers['x-request-id'] ?? randomUUID(),
+    text: `${headers['x-github-event'] ?? headers['x-intercom-topic'] ?? 'event'} ${method} ${url}`,
+    payload: { headers, body },
+  };
+}

package/runtime/node_modules/@metro-labs/whatsapp/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@metro-labs/whatsapp",
+  "version": "0.1.0",
+  "private": true,
+  "type": "module",
+  "exports": {
+    ".": "./src/station.ts",
+    "./train": "./src/index.ts",
+    "./login": "./src/login.ts"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "tsc --noEmit && bun test test/"
+  },
+  "dependencies": {
+    "@metro-labs/core": "workspace:*",
+    "baileys": "7.0.0-rc14"
+  },
+  "devDependencies": {
+    "@stage-labs/config": "0.1.0-beta.3",
+    "eslint": "^10.3.0",
+    "knip": "^6.15.0",
+    "madge": "^8.0.0",
+    "typescript": "^5"
+  }
+}

package/runtime/node_modules/@metro-labs/whatsapp/src/accounts.ts

@@ -0,0 +1,45 @@
+import {
+  makeAccountStore,
+  resolveAccountId,
+  type Die,
+} from '@metro-labs/core/stations/account-store';
+import type { WhatsAppAccount } from './types.js';
+
+const isJid = (s: string): boolean => s.includes('@');
+
+function validateAccount(a: WhatsAppAccount, die: Die): void {
+  if (!a.phone || typeof a.phone !== 'string')
+    die(`account '${a.id}' missing phone`);
+}
+
+export const { loadAccounts } = makeAccountStore<WhatsAppAccount>({
+  prefix: 'whatsapp',
+  validate(raw, die) {
+    for (const a of raw) validateAccount(a, die);
+  },
+});
+
+export const accounts = new Map<string, WhatsAppAccount>();
+
+export function accountFor(args: { account?: string; line?: string }): string {
+  return resolveAccountId(accounts, args, (line) => targetOf(line)?.accountId);
+}
+
+export function lineOf(accountId: string, jid: string): string {
+  return `metro://whatsapp/${accountId}/${jid}`;
+}
+
+interface Target {
+  accountId: string;
+  jid: string;
+}
+
+export function targetOf(line: string): Target | undefined {
+  const prefix = 'metro://whatsapp/';
+  if (!line.startsWith(prefix)) return undefined;
+  const path = line.slice(prefix.length).split('/').filter(Boolean);
+  const [accountId, jid] = path;
+  if (path.length !== 2 || accountId === undefined || jid === undefined) return undefined;
+  if (!isJid(jid)) return undefined;
+  return { accountId, jid };
+}

package/runtime/node_modules/@metro-labs/whatsapp/src/ack.ts

@@ -0,0 +1,101 @@
+import { TrainError } from '@metro-labs/core/train-error';
+import type { BinaryNode, WASocket } from 'baileys';
+
+const DEFAULT_ACK_WAIT_MS = 5000;
+
+export function ackWaitMs(raw: string | undefined): number {
+  if (raw === undefined || raw.trim() === '') return DEFAULT_ACK_WAIT_MS;
+  const ms = Number(raw);
+  return Number.isFinite(ms) && ms >= 0 ? ms : DEFAULT_ACK_WAIT_MS;
+}
+
+export const ACK_WAIT_MS = ackWaitMs(process.env.METRO_WHATSAPP_ACK_WAIT_MS);
+
+const RECENT_MAX = 256;
+
+const RESTRICTION = '463';
+
+export interface SendAck {
+  messageId: string;
+  jid: string;
+  error?: string;
+}
+
+export function ackOf(node: BinaryNode): SendAck | undefined {
+  const { id, from, error } = node.attrs;
+  if (!id || !from) return undefined;
+  return { messageId: id, jid: from, ...(error ? { error } : {}) };
+}
+
+export function rejection(ack: SendAck): TrainError | undefined {
+  if (!ack.error) return undefined;
+  if (ack.error === RESTRICTION)
+    return new TrainError(
+      'whatsapp_account_restricted',
+      `WhatsApp refused the message to ${ack.jid} with ack error 463 (MessageAccountRestriction): the send carried no trusted-contact token, so WhatsApp counted it as reaching out to a stranger and this account is under a reach-out timelock. Nothing was delivered, and it must not be retried — every retry counts as another reach-out and deepens the lock.`,
+      { retryable: false },
+    );
+  return new TrainError(
+    'whatsapp_send_refused',
+    `WhatsApp refused the message to ${ack.jid} with ack error ${ack.error}, so it was not delivered`,
+    { retryable: false },
+  );
+}
+
+export interface AckWatch {
+  record(node: BinaryNode): SendAck | undefined;
+  wait(messageId: string, timeoutMs: number): Promise<SendAck | undefined>;
+}
+
+export function makeAckWatch(max: number = RECENT_MAX): AckWatch {
+  const recent = new Map<string, SendAck>();
+  const waiting = new Map<string, (ack: SendAck) => void>();
+  return {
+    record(node) {
+      const ack = ackOf(node);
+      if (!ack) return undefined;
+      const waiter = waiting.get(ack.messageId);
+      if (waiter) {
+        waiting.delete(ack.messageId);
+        waiter(ack);
+        return ack;
+      }
+      recent.delete(ack.messageId);
+      recent.set(ack.messageId, ack);
+      while (recent.size > max) {
+        const oldest = recent.keys().next().value;
+        if (oldest === undefined) break;
+        recent.delete(oldest);
+      }
+      return ack;
+    },
+    wait(messageId, timeoutMs) {
+      const seen = recent.get(messageId);
+      if (seen) {
+        recent.delete(messageId);
+        return Promise.resolve(seen);
+      }
+      return new Promise<SendAck | undefined>((resolve) => {
+        const timer = setTimeout(() => {
+          waiting.delete(messageId);
+          resolve(undefined);
+        }, timeoutMs);
+        waiting.set(messageId, (ack) => {
+          clearTimeout(timer);
+          resolve(ack);
+        });
+      });
+    },
+  };
+}
+
+export function bindAcks(
+  sock: WASocket,
+  watch: AckWatch,
+  onError: (ack: SendAck) => void,
+): void {
+  sock.ws.on('CB:ack,class:message', (node: BinaryNode) => {
+    const ack = watch.record(node);
+    if (ack?.error) onError(ack);
+  });
+}