@telepapo/sdk 0.3.0 → 0.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@telepapo/sdk",
-  "version": "0.3.0",
+  "version": "0.5.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

@@ -68,3 +68,44 @@ export function botaoEscolhido(conteudo) {
   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) };
 }
+
+export const MAX_ITENS_LISTA = 10;
+
+const umaLinha = (v) => limparTexto(v).replace(/\s+/g, ' ').trim();
+const tamanho = (s) => [...s].length;
+
+/**
+ * Confere e normaliza uma lista de opções (até 10 itens no total, em seções):
+ *   { botao: 'Escolher uma opção', secoes: [{ titulo?, itens: [{ id, titulo, descricao? }] }] }
+ * O cliente escolhe um item e a resposta chega como a de um botão
+ * (`botaoEscolhido(conteudo).id` é o id do item).
+ */
+export function validarLista(lista) {
+  const botao = umaLinha(lista?.botao);
+  if (!botao || tamanho(botao) > 20) throw new Error('Lista: botao de 1 a 20 caracteres.');
+  const secoes = lista.secoes;
+  if (!Array.isArray(secoes) || !secoes.length || secoes.length > 10) throw new Error('Lista: de 1 a 10 seções.');
+  const ids = new Set();
+  let total = 0;
+  const saida = secoes.map((s, si) => {
+    const titulo = s?.titulo == null ? '' : umaLinha(s.titulo);
+    if (tamanho(titulo) > 24) throw new Error(`Seção ${si + 1}: título até 24 caracteres.`);
+    if (!Array.isArray(s.itens) || !s.itens.length) throw new Error(`Seção ${si + 1}: pelo menos 1 item.`);
+    const itens = s.itens.map((it, ii) => {
+      const onde = `Seção ${si + 1}, item ${ii + 1}`;
+      const id = String(it?.id ?? '').trim();
+      if (!id || id.length > 64) throw new Error(`${onde}: id de 1 a 64 caracteres.`);
+      if (ids.has(id)) throw new Error(`${onde}: id "${id}" repetido.`);
+      ids.add(id);
+      const t = umaLinha(it.titulo);
+      if (!t || tamanho(t) > 24) throw new Error(`${onde}: título de 1 a 24 caracteres.`);
+      const d = it.descricao == null ? '' : umaLinha(it.descricao);
+      if (tamanho(d) > 72) throw new Error(`${onde}: descrição até 72 caracteres.`);
+      return { id, titulo: t, ...(d ? { descricao: d } : {}) };
+    });
+    total += itens.length;
+    return { ...(titulo ? { titulo } : {}), itens };
+  });
+  if (total > MAX_ITENS_LISTA) throw new Error(`Lista: no máximo ${MAX_ITENS_LISTA} itens no total.`);
+  return { botao, secoes: saida };
+}

package/src/index.js

@@ -10,14 +10,15 @@ 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';
+import { validarBotoes, validarLista, 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 { validarBotoes, validarLista, botaoEscolhido, limparTexto } from './botoes.js';
+export { pedidoDe, pedidoAcaoDe, enderecoDe, FORMAS_PAGAMENTO } from './pedido.js';
 
 export class ErroTelePapo extends Error {
   constructor(status, corpo) {
@@ -58,7 +59,7 @@ export class TelePapo {
   }
 
   async http(metodo, caminho, { corpo, token, basic } = {}) {
-    const headers = { 'User-Agent': 'telepapo-sdk/0.3' };
+    const headers = { 'User-Agent': 'telepapo-sdk/0.5' };
     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');
@@ -189,6 +190,85 @@ class Conta {
     return { id: e.id, nome: e.nome, username: e.username, escopos: e.escopos };
   }
 
+  // ------------------------------------------------------------ catálogo
+  // Permissão `catalogo.gerenciar`. O sistema do comércio sincroniza os itens
+  // pelo CÓDIGO dele (SKU): salvar de novo o mesmo código atualiza, não duplica.
+
+  /** Itens do catálogo da conta (com `codigo` e `categoria`). */
+  listarCatalogo() {
+    return this.api('GET', '/v1/eu/catalogo');
+  }
+
+  /**
+   * Cria ou atualiza o item com este código.
+   * @param {string} codigo letras, números, ponto, hífen ou sublinhado (até 64)
+   * @param {{nome: string, descricao?: string, precoCentavos: number, precoPromoCentavos?: number|null, disponivel?: boolean, categoria?: string|null}} item
+   */
+  salvarItemDoCatalogo(codigo, item) {
+    return this.api('PUT', `/v1/eu/catalogo/codigo/${encodeURIComponent(codigo)}`, item);
+  }
+
+  removerItemDoCatalogo(codigo) {
+    return this.api('DELETE', `/v1/eu/catalogo/codigo/${encodeURIComponent(codigo)}`);
+  }
+
+  /** Foto do item (JPEG, PNG ou WebP, até 2 MB). */
+  async trocarFotoDoItem(codigo, imagem, mime) {
+    if (!['image/jpeg', 'image/png', 'image/webp'].includes(mime)) throw new Error('Foto: image/jpeg, image/png ou image/webp.');
+    const token = await this.token();
+    const r = await this.cliente.fetch(`${this.cliente.apiUrl}/v1/eu/catalogo/codigo/${encodeURIComponent(codigo)}/foto`, {
+      method: 'PUT',
+      headers: { Authorization: `Bearer ${token}`, 'Content-Type': mime, 'User-Agent': 'telepapo-sdk/0.5' },
+      body: imagem,
+    });
+    if (!r.ok) {
+      const t = await r.text();
+      throw new ErroTelePapo(r.status, t ? JSON.parse(t) : null);
+    }
+  }
+
+  // ------------------------------------------------------------ pedidos
+  // Permissão `pedidos.gerenciar` (docs/API.md, seção 6.7). O servidor guarda só
+  // o registro (de quem, quando, situação e andamento); itens, preços, entrega e
+  // pagamento vêm na própria mensagem, cifrados (`pedidoDe(mensagem.conteudo)`).
+
+  /**
+   * Pedidos recebidos, do mais novo para o mais antigo.
+   * @param {{situacao?: 'ABERTO'|'CONCLUIDO'|'CANCELADO', cliente?: string, antes?: string, limite?: number}} [filtro]
+   * @returns {Promise<{pedidos: Array<{mensagemId: string, cliente: {id: string, nome: string|null, username: string|null, telefone: string}, situacao: string, criadoEm: string, concluidoEm: string|null, acoes: Array<{codigo: string, descricao: string, em: string}>}>, proximo: string|null}>}
+   */
+  listarPedidos(filtro = {}) {
+    const q = new URLSearchParams(Object.entries(filtro).filter(([, v]) => v != null).map(([k, v]) => [k, String(v)]));
+    return this.api('GET', `/v1/eu/pedidos${q.size ? `?${q}` : ''}`);
+  }
+
+  pedido(mensagemId) {
+    return this.api('GET', `/v1/eu/pedidos/${encodeURIComponent(mensagemId)}`);
+  }
+
+  /**
+   * Grava uma resposta no andamento do pedido **e** avisa o cliente na
+   * conversa (texto citando o pedido, com `pedidoAcao`). `CONCLUIDO` conclui.
+   * Sem `descricao`, vale a das respostas do pedido configuradas no perfil.
+   * @param {string} cliente id de quem fez o pedido (`mensagem.de`)
+   * @param {string} mensagemId id da mensagem do pedido (`mensagem.conteudo.id`)
+   */
+  async atualizarPedido(cliente, mensagemId, codigo, { descricao } = {}) {
+    const p = await this.api('POST', `/v1/eu/pedidos/${encodeURIComponent(mensagemId)}/acoes`, { codigo, ...(descricao ? { descricao } : {}) });
+    const feita = p.acoes[p.acoes.length - 1];
+    await this.enviar(cliente, {
+      tipo: 'texto',
+      texto: `${codigo === 'CONCLUIDO' ? '✅' : '📦'} ${feita.descricao}`,
+      resposta: { id: mensagemId, autorId: cliente, trecho: '🛒 Pedido' },
+      pedidoAcao: { pedido: mensagemId, codigo, descricao: feita.descricao },
+    });
+    return p;
+  }
+
+  concluirPedido(cliente, mensagemId) {
+    return this.atualizarPedido(cliente, mensagemId, 'CONCLUIDO');
+  }
+
   // ------------------------------------------------------------ receber
 
   /** Busca o que está pendente (alternativa/complemento ao webhook), decifra e confirma. */
@@ -318,14 +398,17 @@ class Conta {
   /**
    * Texto (com *negrito*, _itálico_, ~riscado~ e `código`, que o app mostra
    * formatados). `botoes`: até 3 (só conta comercial; ver validarBotoes).
+   * `lista`: menu de até 10 opções atrás de um botão (ver validarLista).
    */
-  enviarTexto(para, texto, { resposta, botoes } = {}) {
+  enviarTexto(para, texto, { resposta, botoes, lista } = {}) {
     if (!texto?.trim()) throw new Error('Texto vazio.');
+    if (botoes && lista) throw new Error('Use botoes ou lista, não os dois.');
     return this.enviar(para, {
       tipo: 'texto',
       texto: texto.slice(0, 65000),
       ...(resposta ? { resposta } : {}),
       ...(botoes ? { botoes: validarBotoes(botoes) } : {}),
+      ...(lista ? { lista: validarLista(lista) } : {}),
     });
   }
 
@@ -364,7 +447,7 @@ 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.3' },
+      headers: { Authorization: `Bearer ${token}`, 'Content-Type': 'application/octet-stream', 'User-Agent': 'telepapo-sdk/0.5' },
       body: blob,
     });
     if (!r.ok) {
@@ -379,7 +462,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.3' },
+      headers: { Authorization: `Bearer ${token}`, 'User-Agent': 'telepapo-sdk/0.5' },
     });
     if (!r.ok) {
       const texto = await r.text();

package/src/pedido.js

@@ -0,0 +1,111 @@
+/**
+ * Pedido do carrinho (docs/MENSAGENS-RICAS.md §6, §8, §9 e §10 do TelePapo):
+ * quem conversa com a conta comercial monta o carrinho com itens do catálogo,
+ * escolhe entrega e pagamento, e envia.
+ *
+ * O preço é o que o CLIENTE VIU, montado no aparelho dele: confira código,
+ * preço e disponibilidade no seu cadastro antes de confirmar o pedido.
+ */
+
+const inteiro = (v, min, max) => Number.isInteger(v) && v >= min && v <= max;
+// Controles e direção do texto (disfarçam texto); tudo vira uma linha.
+const CONTROLES = /[\u0000-\u001F\u007F‪-‮⁦-⁩]/g;
+const texto = (v, max) => {
+  if (typeof v !== 'string') return null;
+  const t = v.replace(CONTROLES, ' ').replace(/\s+/g, ' ').trim();
+  return t ? t.slice(0, max) : null;
+};
+
+/** Formas de pagamento (§10): código → nome. */
+export const FORMAS_PAGAMENTO = {
+  PIX: 'Pix',
+  DINHEIRO: 'Dinheiro',
+  CREDITO: 'Cartão de crédito',
+  DEBITO: 'Cartão de débito',
+  VALE_REFEICAO: 'Vale-refeição',
+  VALE_ALIMENTACAO: 'Vale-alimentação',
+  BOLETO: 'Boleto',
+  TRANSFERENCIA: 'Transferência bancária',
+};
+
+const UFS = new Set('AC AL AP AM BA CE DF ES GO MA MT MS MG PA PB PR PE PI RJ RN RS RO RR SC SP SE TO'.split(' '));
+
+/**
+ * Endereço (§8) de uma mensagem (`conteudo.endereco`) ou de um pedido
+ * (`pedido.entrega`). Inválido: null.
+ * @returns {null | {rotulo: string|null, logradouro: string, numero: string, complemento: string|null, bairro: string|null, cidade: string, uf: string, cep: string|null, referencia: string|null}}
+ */
+export function enderecoDe(e) {
+  if (!e || typeof e !== 'object') return null;
+  const logradouro = texto(e.logradouro, 120);
+  const numero = texto(e.numero, 10);
+  const cidade = texto(e.cidade, 60);
+  const uf = typeof e.uf === 'string' && UFS.has(e.uf) ? e.uf : null;
+  const cep = typeof e.cep === 'string' && /^\d{5}-\d{3}$/.test(e.cep) ? e.cep : null;
+  if (!logradouro || !numero || !cidade || !uf) return null;
+  return {
+    rotulo: texto(e.rotulo, 30),
+    logradouro, numero,
+    complemento: texto(e.complemento, 60),
+    bairro: texto(e.bairro, 60),
+    cidade, uf, cep,
+    referencia: texto(e.referencia, 120),
+  };
+}
+
+/** Forma de pagamento escolhida no pedido (§10), ou null. */
+function pagamentoDe(p) {
+  if (!p || typeof p !== 'object' || typeof p.codigo !== 'string' || !/^[A-Z0-9_]{1,30}$/.test(p.codigo)) return null;
+  const descricao = FORMAS_PAGAMENTO[p.codigo] ?? texto(p.descricao, 40);
+  if (!descricao) return null;
+  const troco = p.codigo === 'DINHEIRO' && inteiro(p.trocoParaCentavos, 1, 100_000_000) ? p.trocoParaCentavos : null;
+  return { codigo: p.codigo, descricao, trocoParaCentavos: troco };
+}
+
+/**
+ * Lê o pedido de uma mensagem recebida (`mensagem.conteudo`). Itens
+ * malformados são descartados; sem nenhum item válido, devolve null.
+ * @returns {null | { loja: string|null, itens: Array<{produtoId: string|null, codigo: string|null, descricao: string, quantidade: number, precoCentavos: number, totalCentavos: number}>, totalCentavos: number, moeda: string, observacao: string|null, entrega: ReturnType<typeof enderecoDe>, pagamento: null | {codigo: string, descricao: string, trocoParaCentavos: number|null} }}
+ */
+export function pedidoDe(conteudo) {
+  const p = conteudo?.pedido;
+  if (!p || typeof p !== 'object' || !Array.isArray(p.itens)) return null;
+  const itens = p.itens.slice(0, 50).flatMap((i) => {
+    const descricao = texto(i?.descricao, 80);
+    if (!descricao || !inteiro(i.quantidade, 1, 999) || !inteiro(i.precoCentavos, 0, 100_000_000)) return [];
+    return [{
+      produtoId: texto(i.produtoId, 64),
+      codigo: texto(i.codigo, 64),
+      descricao,
+      quantidade: i.quantidade,
+      precoCentavos: i.precoCentavos,
+      // Recalculado aqui: não confie no total que veio.
+      totalCentavos: i.quantidade * i.precoCentavos,
+    }];
+  });
+  if (!itens.length) return null;
+  return {
+    loja: texto(p.loja, 64),
+    itens,
+    totalCentavos: itens.reduce((s, i) => s + i.totalCentavos, 0),
+    moeda: 'BRL',
+    observacao: texto(p.observacao, 500),
+    entrega: enderecoDe(p.entrega),
+    pagamento: pagamentoDe(p.pagamento),
+  };
+}
+
+/**
+ * Andamento de pedido numa mensagem (§9): a resposta da loja ou o
+ * cancelamento do cliente. Confira quem mandou: `CANCELADO` só vale do cliente
+ * do pedido; os outros códigos, só da loja.
+ * @returns {null | {pedido: string, codigo: string, descricao: string}}
+ */
+export function pedidoAcaoDe(conteudo) {
+  const a = conteudo?.pedidoAcao;
+  if (!a || typeof a !== 'object') return null;
+  const pedido = typeof a.pedido === 'string' && /^[A-Za-z0-9_-]{8,64}$/.test(a.pedido) ? a.pedido : null;
+  const codigo = typeof a.codigo === 'string' && /^[A-Z0-9_]{1,30}$/.test(a.codigo) ? a.codigo : null;
+  const descricao = texto(a.descricao, 40);
+  return pedido && codigo && descricao ? { pedido, codigo, descricao } : null;
+}