wizards 0.4.0 → 0.4.2

package/modules/whatsapp/src/graph.ts

@@ -1,271 +0,0 @@
-/**
- * Meta's WhatsApp Cloud API, the part this plugin uses: sending a message to a number, marking
- * one read, and fetching a file the person sent. The tenant's own number and token; the limits
- * of the API (how long a button may be, how many rows a list holds) are kept here.
- */
-
-export const GRAPH = "https://graph.facebook.com/v22.0";
-
-export interface Account {
-  phoneNumberId: string;
-  number: string;
-  accessToken: string;
-  appSecret: string | null;
-  verifyToken: string;
-  template: string | null;
-}
-
-/** Three buttons of twenty characters at most; a list holds ten rows of twenty-four. */
-export const LIMITS = {
-  buttons: 3,
-  buttonTitle: 20,
-  rows: 10,
-  rowTitle: 24,
-  rowDescription: 72,
-  listButton: 20,
-  body: 1024,
-  text: 4096,
-  caption: 1024,
-  header: 60,
-} as const;
-
-export type Outgoing =
-  | { type: "text"; text: string; preview?: boolean }
-  | { type: "buttons"; text: string; buttons: { id: string; title: string }[]; header?: string }
-  | {
-      type: "list";
-      text: string;
-      button: string;
-      rows: { id: string; title: string; description?: string }[];
-      header?: string;
-    }
-  | { type: "image"; link: string; caption?: string }
-  | { type: "document"; link: string; caption?: string; filename?: string }
-  | { type: "video"; link: string; caption?: string }
-  | { type: "audio"; link: string }
-  | { type: "link"; text: string; url: string; label: string }
-  | { type: "location_request"; text: string }
-  | { type: "template"; name: string; lang: string; params: string[] };
-
-export class GraphError extends Error {
-  constructor(
-    message: string,
-    readonly status: number,
-    readonly code: number | null,
-  ) {
-    super(message);
-    this.name = "GraphError";
-  }
-}
-
-/** Outside the 24-hour window a free-form message is refused with this code. */
-export const RE_ENGAGEMENT = 131047;
-
-/** Cut to a length, with an ellipsis where something was cut. */
-export function clip(text: string, max: number): string {
-  const t = text.trim();
-  return t.length > max ? `${t.slice(0, max - 1).trimEnd()}…` : t;
-}
-
-function body(to: string, message: Outgoing): Record<string, unknown> {
-  const base = { messaging_product: "whatsapp", recipient_type: "individual", to };
-  switch (message.type) {
-    case "text":
-      return {
-        ...base,
-        type: "text",
-        text: { body: clip(message.text, LIMITS.text), preview_url: message.preview ?? false },
-      };
-    case "buttons":
-      return {
-        ...base,
-        type: "interactive",
-        interactive: {
-          type: "button",
-          ...(message.header
-            ? { header: { type: "text", text: clip(message.header, LIMITS.header) } }
-            : {}),
-          body: { text: clip(message.text, LIMITS.body) },
-          action: {
-            buttons: message.buttons.slice(0, LIMITS.buttons).map((b) => ({
-              type: "reply",
-              reply: { id: b.id, title: clip(b.title, LIMITS.buttonTitle) },
-            })),
-          },
-        },
-      };
-    case "list":
-      return {
-        ...base,
-        type: "interactive",
-        interactive: {
-          type: "list",
-          ...(message.header
-            ? { header: { type: "text", text: clip(message.header, LIMITS.header) } }
-            : {}),
-          body: { text: clip(message.text, LIMITS.body) },
-          action: {
-            button: clip(message.button, LIMITS.listButton),
-            sections: [
-              {
-                rows: message.rows.slice(0, LIMITS.rows).map((r) => ({
-                  id: r.id,
-                  title: clip(r.title, LIMITS.rowTitle),
-                  ...(r.description
-                    ? { description: clip(r.description, LIMITS.rowDescription) }
-                    : {}),
-                })),
-              },
-            ],
-          },
-        },
-      };
-    case "image":
-      return {
-        ...base,
-        type: "image",
-        image: {
-          link: message.link,
-          ...(message.caption ? { caption: clip(message.caption, LIMITS.caption) } : {}),
-        },
-      };
-    case "document":
-      return {
-        ...base,
-        type: "document",
-        document: {
-          link: message.link,
-          ...(message.caption ? { caption: clip(message.caption, LIMITS.caption) } : {}),
-          ...(message.filename ? { filename: message.filename } : {}),
-        },
-      };
-    case "video":
-      return {
-        ...base,
-        type: "video",
-        video: {
-          link: message.link,
-          ...(message.caption ? { caption: clip(message.caption, LIMITS.caption) } : {}),
-        },
-      };
-    case "audio":
-      return { ...base, type: "audio", audio: { link: message.link } };
-    case "link":
-      return {
-        ...base,
-        type: "interactive",
-        interactive: {
-          type: "cta_url",
-          body: { text: clip(message.text, LIMITS.body) },
-          action: {
-            name: "cta_url",
-            parameters: { display_text: clip(message.label, LIMITS.buttonTitle), url: message.url },
-          },
-        },
-      };
-    case "location_request":
-      return {
-        ...base,
-        type: "interactive",
-        interactive: {
-          type: "location_request_message",
-          body: { text: clip(message.text, LIMITS.body) },
-          action: { name: "send_location" },
-        },
-      };
-    case "template":
-      return {
-        ...base,
-        type: "template",
-        template: {
-          name: message.name,
-          language: { code: message.lang },
-          components: message.params.length
-            ? [
-                {
-                  type: "body",
-                  parameters: message.params.map((text) => ({ type: "text", text })),
-                },
-              ]
-            : [],
-        },
-      };
-  }
-}
-
-export class Graph {
-  constructor(
-    private readonly account: Account,
-    private readonly fetchImpl: typeof fetch = (...args) => globalThis.fetch(...args),
-  ) {}
-
-  private async call(path: string, init: RequestInit): Promise<Record<string, unknown>> {
-    const res = await this.fetchImpl(`${GRAPH}/${path}`, {
-      ...init,
-      headers: {
-        authorization: `Bearer ${this.account.accessToken}`,
-        "content-type": "application/json",
-        ...(init.headers ?? {}),
-      },
-      signal: AbortSignal.timeout(20_000),
-    });
-    const text = await res.text();
-    let parsed: Record<string, unknown> = {};
-    try {
-      parsed = text ? (JSON.parse(text) as Record<string, unknown>) : {};
-    } catch {
-      parsed = {};
-    }
-    if (!res.ok) {
-      const error = (parsed.error ?? {}) as { message?: string; code?: number };
-      throw new GraphError(
-        error.message ?? `WhatsApp answered ${res.status}.`,
-        res.status,
-        typeof error.code === "number" ? error.code : null,
-      );
-    }
-    return parsed;
-  }
-
-  /** Sends one message; gives the message's id. */
-  async send(to: string, message: Outgoing): Promise<string | null> {
-    const answer = await this.call(`${this.account.phoneNumberId}/messages`, {
-      method: "POST",
-      body: JSON.stringify(body(to, message)),
-    });
-    const messages = answer.messages as { id?: string }[] | undefined;
-    return messages?.[0]?.id ?? null;
-  }
-
-  /** The two ticks turn blue: the person sees their message arrived. */
-  async markRead(messageId: string): Promise<void> {
-    await this.call(`${this.account.phoneNumberId}/messages`, {
-      method: "POST",
-      body: JSON.stringify({
-        messaging_product: "whatsapp",
-        status: "read",
-        message_id: messageId,
-      }),
-    });
-  }
-
-  /** A file the person sent, by the id the webhook named: its bytes and type. */
-  async media(id: string): Promise<{ data: Uint8Array; mime: string }> {
-    const meta = await this.call(id, { method: "GET" });
-    const url = typeof meta.url === "string" ? meta.url : null;
-    if (!url) {
-      throw new GraphError("The file has no address.", 404, null);
-    }
-    const res = await this.fetchImpl(url, {
-      headers: { authorization: `Bearer ${this.account.accessToken}` },
-      signal: AbortSignal.timeout(60_000),
-    });
-    if (!res.ok) {
-      throw new GraphError(`The file could not be fetched (${res.status}).`, res.status, null);
-    }
-    const mime =
-      (typeof meta.mime_type === "string" ? meta.mime_type : res.headers.get("content-type")) ??
-      "application/octet-stream";
-    return { data: new Uint8Array(await res.arrayBuffer()), mime: mime.split(";")[0].trim() };
-  }
-}

package/modules/whatsapp/src/inbound.ts

@@ -1,143 +0,0 @@
-import { createHmac, timingSafeEqual } from "node:crypto";
-
-/**
- * What Meta posts to the webhook, read into one shape per message: text, a tap on a button or
- * a row, a file, a location. Statuses (sent, delivered, read) are left out.
- */
-
-export interface Inbound {
-  id: string;
-  /** The person's number, as WhatsApp names it (digits, no plus). */
-  from: string;
-  name: string | null;
-  /** The number it was sent to, by its id. */
-  phoneNumberId: string;
-  at: number;
-  kind: "text" | "reply" | "image" | "document" | "video" | "audio" | "location" | "other";
-  text?: string;
-  /** The id of the button or the row the person tapped. */
-  replyId?: string;
-  replyTitle?: string;
-  media?: { id: string; mime: string; filename?: string; caption?: string };
-  location?: { lat: number; lng: number; name?: string; address?: string };
-}
-
-type Rec = Record<string, unknown>;
-const rec = (v: unknown): Rec =>
-  v && typeof v === "object" && !Array.isArray(v) ? (v as Rec) : {};
-const str = (v: unknown): string | undefined => (typeof v === "string" && v ? v : undefined);
-
-function oneMessage(m: Rec, phoneNumberId: string, name: string | null): Inbound | null {
-  const id = str(m.id);
-  const from = str(m.from);
-  if (!id || !from) {
-    return null;
-  }
-  const at = Number(m.timestamp) * 1000 || Date.now();
-  const base = { id, from, name, phoneNumberId, at };
-  switch (m.type) {
-    case "text":
-      return { ...base, kind: "text", text: str(rec(m.text).body) ?? "" };
-    case "interactive": {
-      const i = rec(m.interactive);
-      const reply = rec(i.button_reply ?? i.list_reply);
-      return {
-        ...base,
-        kind: "reply",
-        replyId: str(reply.id) ?? "",
-        replyTitle: str(reply.title),
-        text: str(reply.title),
-      };
-    }
-    case "button":
-      // A tap on a template's quick-reply button.
-      return {
-        ...base,
-        kind: "reply",
-        replyId: str(rec(m.button).payload) ?? "",
-        text: str(rec(m.button).text),
-      };
-    case "image":
-    case "document":
-    case "video":
-    case "audio": {
-      const file = rec(m[m.type]);
-      const mediaId = str(file.id);
-      if (!mediaId) {
-        return null;
-      }
-      return {
-        ...base,
-        kind: m.type,
-        media: {
-          id: mediaId,
-          mime: str(file.mime_type) ?? "application/octet-stream",
-          filename: str(file.filename),
-          caption: str(file.caption),
-        },
-        text: str(file.caption),
-      };
-    }
-    case "location": {
-      const l = rec(m.location);
-      const lat = Number(l.latitude);
-      const lng = Number(l.longitude);
-      if (!(Number.isFinite(lat) && Number.isFinite(lng))) {
-        return null;
-      }
-      return {
-        ...base,
-        kind: "location",
-        location: { lat, lng, name: str(l.name), address: str(l.address) },
-      };
-    }
-    default:
-      return { ...base, kind: "other" };
-  }
-}
-
-/** Every message in a webhook's body, oldest first. */
-export function parseWebhook(body: unknown): Inbound[] {
-  const out: Inbound[] = [];
-  const root = rec(body);
-  if (root.object !== "whatsapp_business_account") {
-    return out;
-  }
-  for (const entry of Array.isArray(root.entry) ? root.entry : []) {
-    for (const change of Array.isArray(rec(entry).changes)
-      ? (rec(entry).changes as unknown[])
-      : []) {
-      const value = rec(rec(change).value);
-      if (rec(change).field !== "messages") {
-        continue;
-      }
-      const phoneNumberId = str(rec(value.metadata).phone_number_id) ?? "";
-      const contacts = Array.isArray(value.contacts) ? (value.contacts as unknown[]) : [];
-      const names = new Map(
-        contacts.map((c) => [str(rec(c).wa_id) ?? "", str(rec(rec(c).profile).name) ?? null]),
-      );
-      for (const m of Array.isArray(value.messages) ? (value.messages as unknown[]) : []) {
-        const message = rec(m);
-        const parsed = oneMessage(
-          message,
-          phoneNumberId,
-          names.get(str(message.from) ?? "") ?? null,
-        );
-        if (parsed) {
-          out.push(parsed);
-        }
-      }
-    }
-  }
-  return out.sort((a, b) => a.at - b.at);
-}
-
-/** `X-Hub-Signature-256` is the HMAC of the raw body with the app's secret. */
-export function signatureOk(secret: string, raw: string, header: string | null): boolean {
-  if (!header?.startsWith("sha256=")) {
-    return false;
-  }
-  const expected = Buffer.from(createHmac("sha256", secret).update(raw, "utf8").digest("hex"));
-  const given = Buffer.from(header.slice("sha256=".length));
-  return expected.length === given.length && timingSafeEqual(expected, given);
-}