@telepapo/sdk 0.2.0 → 0.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@telepapo/sdk",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "SDK do TelePapo Developers: autorize contas comerciais e receba e responda mensagens com criptografia de ponta a ponta (Signal).",
   "type": "module",
   "main": "src/index.js",

package/src/botoes.js

@@ -0,0 +1,70 @@
+/**
+ * Botões nas mensagens (só conta comercial; ver docs/MENSAGENS-RICAS.md no
+ * repositório do TelePapo). As mesmas regras valem no app Android e no web:
+ * quem recebe descarta o botão que não passa nelas.
+ *
+ *   { id, tipo: 'resposta' | 'link' | 'telefone', rotulo, url?, telefone? }
+ */
+
+export const MAX_BOTOES = 3;
+export const MAX_ROTULO = 25;
+export const MAX_LEGENDA = 1024;
+
+// Controles invisíveis (direção do texto e afins) disfarçam texto e links.
+const CONTROLES = /[\u0000-\u0008\u000B-\u001F\u007F‪-‮⁦-⁩]/g;
+
+/** Tira caracteres de controle e de direção (mantém \n e \t). */
+export function limparTexto(texto) {
+  return String(texto ?? '').replace(CONTROLES, '');
+}
+
+function erro(i, motivo) {
+  return new Error(`Botão ${i + 1}: ${motivo}`);
+}
+
+/**
+ * Confere e normaliza os botões de uma mensagem a enviar. Lança com o motivo
+ * (erro de quem chama: melhor saber agora do que o cliente não ver o botão).
+ * @returns {Array<{id: string, tipo: string, rotulo: string, url?: string, telefone?: string}>}
+ */
+export function validarBotoes(botoes) {
+  if (!Array.isArray(botoes) || !botoes.length) throw new Error('Informe de 1 a 3 botões.');
+  if (botoes.length > MAX_BOTOES) throw new Error(`No máximo ${MAX_BOTOES} botões por mensagem.`);
+  const ids = new Set();
+  return botoes.map((b, i) => {
+    const id = String(b?.id ?? '').trim();
+    if (!id || id.length > 64) throw erro(i, 'id de 1 a 64 caracteres.');
+    if (ids.has(id)) throw erro(i, `id "${id}" repetido.`);
+    ids.add(id);
+    const rotulo = limparTexto(b.rotulo).replace(/\s+/g, ' ').trim();
+    if (!rotulo || [...rotulo].length > MAX_ROTULO) throw erro(i, `rótulo de 1 a ${MAX_ROTULO} caracteres.`);
+    switch (b.tipo) {
+      case 'resposta':
+        return { id, tipo: 'resposta', rotulo };
+      case 'link': {
+        const url = String(b.url ?? '').trim();
+        let u;
+        try { u = new URL(url); } catch { throw erro(i, 'url inválida.'); }
+        if (!['https:', 'http:'].includes(u.protocol) || url.length > 2000) throw erro(i, 'url precisa ser http(s) e ter até 2000 caracteres.');
+        return { id, tipo: 'link', rotulo, url };
+      }
+      case 'telefone': {
+        const telefone = String(b.telefone ?? '').replace(/[^\d+]/g, '');
+        if (!/^\+\d{8,15}$/.test(telefone)) throw erro(i, 'telefone no formato +5511912345678.');
+        return { id, tipo: 'telefone', rotulo, telefone };
+      }
+      default:
+        throw erro(i, 'tipo deve ser resposta, link ou telefone.');
+    }
+  });
+}
+
+/**
+ * Botão escolhido numa mensagem recebida (`conteudo.botao`), quando o cliente
+ * tocou num botão de resposta: `{ id, msg }` (id do botão e da mensagem).
+ */
+export function botaoEscolhido(conteudo) {
+  const b = conteudo?.botao;
+  if (!b || typeof b.id !== 'string' || typeof b.msg !== 'string') return null;
+  return { id: b.id.slice(0, 64), msg: b.msg.slice(0, 64) };
+}

package/src/index.js

@@ -10,12 +10,14 @@ import { ArmazenamentoArquivo, ArmazenamentoMemoria } from './armazenamento.js';
 import { verificarAssinatura } from './webhook.js';
 import { categoria, impressao } from './categoria.js';
 import { abrirAnexo, prepararAnexo } from './anexos.js';
+import { validarBotoes, MAX_LEGENDA } from './botoes.js';
 
 const require = createRequire(import.meta.url);
 const { Signal } = require('../signal/telepapo_signal.js');
 
 export { ArmazenamentoArquivo, ArmazenamentoMemoria, verificarAssinatura };
 export { cifrarAnexo, decifrarAnexo } from './anexos.js';
+export { validarBotoes, botaoEscolhido, limparTexto } from './botoes.js';
 
 export class ErroTelePapo extends Error {
   constructor(status, corpo) {
@@ -56,7 +58,7 @@ export class TelePapo {
   }
 
   async http(metodo, caminho, { corpo, token, basic } = {}) {
-    const headers = { 'User-Agent': 'telepapo-sdk/0.2' };
+    const headers = { 'User-Agent': 'telepapo-sdk/0.3' };
     if (corpo !== undefined) headers['Content-Type'] = 'application/json';
     if (token) headers.Authorization = `Bearer ${token}`;
     if (basic) headers.Authorization = 'Basic ' + Buffer.from(`${this.clientId}:${this.credencial}`).toString('base64');
@@ -313,9 +315,18 @@ class Conta {
     });
   }
 
-  enviarTexto(para, texto, { resposta } = {}) {
+  /**
+   * Texto (com *negrito*, _itálico_, ~riscado~ e `código`, que o app mostra
+   * formatados). `botoes`: até 3 (só conta comercial; ver validarBotoes).
+   */
+  enviarTexto(para, texto, { resposta, botoes } = {}) {
     if (!texto?.trim()) throw new Error('Texto vazio.');
-    return this.enviar(para, { tipo: 'texto', texto: texto.slice(0, 65000), ...(resposta ? { resposta } : {}) });
+    return this.enviar(para, {
+      tipo: 'texto',
+      texto: texto.slice(0, 65000),
+      ...(resposta ? { resposta } : {}),
+      ...(botoes ? { botoes: validarBotoes(botoes) } : {}),
+    });
   }
 
   /** Avisa quem escreveu que a conta leu (e o celular do dono também). */
@@ -344,7 +355,7 @@ class Conta {
   /**
    * Cifra e sobe um arquivo; devolve o `anexo` para pôr numa mensagem `midia`.
    * @param {Buffer|Uint8Array} dados
-   * @param {{mime: string, nome?: string, largura?: number, altura?: number, duracaoMs?: number, miniatura?: string}} info
+   * @param {{mime: string, nome?: string, largura?: number, altura?: number, duracaoMs?: number, onda?: string, miniatura?: string}} info
    */
   async subirAnexo(dados, info = {}) {
     if (!info.mime) throw new Error('Informe o mime do anexo.');
@@ -353,14 +364,14 @@ class Conta {
     const token = await this.token();
     const r = await this.cliente.fetch(`${this.cliente.apiUrl}/v1/anexos/${id}/conteudo`, {
       method: 'PUT',
-      headers: { Authorization: `Bearer ${token}`, 'Content-Type': 'application/octet-stream', 'User-Agent': 'telepapo-sdk/0.2' },
+      headers: { Authorization: `Bearer ${token}`, 'Content-Type': 'application/octet-stream', 'User-Agent': 'telepapo-sdk/0.3' },
       body: blob,
     });
     if (!r.ok) {
       const texto = await r.text();
       throw new ErroTelePapo(r.status, texto ? JSON.parse(texto) : null);
     }
-    const extra = Object.fromEntries(['nome', 'largura', 'altura', 'duracaoMs', 'miniatura'].filter((k) => info[k] != null).map((k) => [k, info[k]]));
+    const extra = Object.fromEntries(['nome', 'largura', 'altura', 'duracaoMs', 'onda', 'miniatura'].filter((k) => info[k] != null).map((k) => [k, info[k]]));
     return { id, chave, digest, tamanho: Buffer.byteLength(Buffer.from(dados)), mime: info.mime, ...extra };
   }
 
@@ -368,7 +379,7 @@ class Conta {
   async baixarAnexo(anexo) {
     const token = await this.token();
     const r = await this.cliente.fetch(`${this.cliente.apiUrl}/v1/anexos/${encodeURIComponent(anexo.id)}`, {
-      headers: { Authorization: `Bearer ${token}`, 'User-Agent': 'telepapo-sdk/0.2' },
+      headers: { Authorization: `Bearer ${token}`, 'User-Agent': 'telepapo-sdk/0.3' },
     });
     if (!r.ok) {
       const texto = await r.text();
@@ -378,13 +389,20 @@ class Conta {
   }
 
   /**
-   * Envia um arquivo (foto, vídeo, áudio, documento). A mensagem de mídia do
-   * TelePapo não tem legenda: `legenda`, se houver, vai logo depois como texto.
+   * Envia um arquivo (foto, vídeo, áudio, documento). `legenda` vai na própria
+   * mídia (até 1024 caracteres; o app mostra abaixo da imagem/vídeo/documento).
+   * Áudio: `duracaoMs` e `onda` (base64 de até 64 barras 0-255) desenham o player.
    */
-  async enviarArquivo(para, dados, { mime, nome, largura, altura, duracaoMs, miniatura, legenda, resposta } = {}) {
-    const anexo = await this.subirAnexo(dados, { mime, nome, largura, altura, duracaoMs, miniatura });
-    const r = await this.enviar(para, { tipo: 'midia', anexo, ...(resposta ? { resposta } : {}) });
-    if (legenda?.trim()) await this.enviarTexto(para, legenda);
+  async enviarArquivo(para, dados, { mime, nome, largura, altura, duracaoMs, onda, miniatura, legenda, resposta, botoes } = {}) {
+    const anexo = await this.subirAnexo(dados, { mime, nome, largura, altura, duracaoMs, onda, miniatura });
+    const texto = legenda?.trim() ? legenda.trim().slice(0, MAX_LEGENDA) : null;
+    const r = await this.enviar(para, {
+      tipo: 'midia',
+      anexo,
+      ...(texto ? { texto } : {}),
+      ...(resposta ? { resposta } : {}),
+      ...(botoes ? { botoes: validarBotoes(botoes) } : {}),
+    });
     return { ...r, anexo };
   }