@lexnode/legal-data-sdk 1.30.0 → 1.31.0

package/dist/webhooks.js

@@ -1,29 +1,11 @@
 import { createHmac, timingSafeEqual } from "node:crypto";
-/**
- * Verificação e tipagem das entregas assinadas do motor.
- *
- * O motor assina cada entrega como `x-lexnode-signature: t=<unix>,v1=<hex>`,
- * onde o HMAC-SHA256 cobre `${t}.${corpoCru}` com o segredo do endpoint. A
- * conferência é sobre os BYTES CRUS recebidos: reserializar o JSON muda a
- * ordem das chaves e o digest deixa de bater.
- */
 export const LEXNODE_WEBHOOK_HEADERS = {
     event: "x-lexnode-event",
     timestamp: "x-lexnode-timestamp",
     signature: "x-lexnode-signature",
     deliveryAttempt: "x-lexnode-delivery-attempt",
 };
-/** Janela de replay do motor. */
 export const DEFAULT_WEBHOOK_TOLERANCE_SECONDS = 300;
-/**
- * A forma exata do digest que o motor emite: 64 dígitos hex minúsculos.
- *
- * Conferir a forma ANTES de decodificar é o que barra o cabeçalho maleável:
- * `Buffer.from(v1, "hex")` para no primeiro caractere inválido, então um
- * digest válido com lixo colado no fim decodifica nos mesmos bytes e passaria
- * pela guarda de tamanho — a mesma entrega verificaria quantas vezes o
- * remetente quisesse, com cabeçalhos diferentes a cada vez.
- */
 const V1_DIGEST = /^[0-9a-f]{64}$/u;
 function isRawBody(value) {
     return typeof value === "string" || value instanceof Uint8Array;
@@ -55,13 +37,6 @@ function parseSignatureHeader(header) {
     }
     return out;
 }
-/**
- * Confere a assinatura de uma entrega e diz POR QUE recusou.
- *
- * O veredito é motivado de propósito: um `false` nu manda o receptor devolver
- * o mesmo erro para segredo trocado, relógio fora de hora e corpo adulterado —
- * três incidentes com conduta diferente.
- */
 export function verifyWebhookSignature(rawBody, headers, secret, options = {}) {
     if (!secret)
         return { ok: false, reason: "MISSING_SECRET" };
@@ -78,8 +53,6 @@ export function verifyWebhookSignature(rawBody, headers, secret, options = {}) {
     if (!Number.isFinite(timestamp)) {
         return { ok: false, reason: "MALFORMED_SIGNATURE" };
     }
-    // O cabeçalho de timestamp é redundante com o `t` da assinatura — e é por
-    // isso que ele vale: divergir os dois é sinal de corpo remontado no caminho.
     const timestampHeader = readHeader(headers, LEXNODE_WEBHOOK_HEADERS.timestamp);
     if (timestampHeader !== null && timestampHeader.trim() !== t) {
         return { ok: false, reason: "TIMESTAMP_MISMATCH" };
@@ -89,8 +62,6 @@ export function verifyWebhookSignature(rawBody, headers, secret, options = {}) {
     if (Math.abs(now - timestamp) > tolerance) {
         return { ok: false, reason: "TIMESTAMP_OUT_OF_TOLERANCE" };
     }
-    // O prefixo e o corpo entram separados: o corpo em bytes é assinado como
-    // veio, sem passar por uma conversão de texto que possa alterá-lo.
     const mac = createHmac("sha256", secret).update(`${t}.`, "utf8");
     const expected = (typeof rawBody === "string"
         ? mac.update(rawBody, "utf8")
@@ -104,17 +75,7 @@ export function verifyWebhookSignature(rawBody, headers, secret, options = {}) {
     }
     return { ok: true, timestamp };
 }
-/**
- * A entrega de teste, que o endpoint recebe sem assinar.
- *
- * Ela é o PRIMEIRO corpo que um receptor novo vê — o botão de testar
- * conectividade existe para ser apertado antes do primeiro evento real. Por
- * isso está na união (quem faz `switch (event.type)` precisa enxergá-la) e
- * fora do catálogo assinável (não se pede, não se recusa, chega a qualquer
- * endpoint).
- */
 export const WEBHOOK_TEST_EVENT_TYPE = "WEBHOOK_TEST";
-/** Os tipos que se pode ASSINAR ao cadastrar um endpoint. */
 export const WEBHOOK_EVENT_TYPES = [
     "PROCESS_MOVEMENT_CREATED",
     "PROCESS_INSTANCE_DISCOVERED",
@@ -133,26 +94,12 @@ const KNOWN_EVENT_TYPES = new Set([
     ...WEBHOOK_EVENT_TYPES,
     WEBHOOK_TEST_EVENT_TYPE,
 ]);
-/** Se o tipo está no catálogo que este pacote descreve. */
 export function isKnownWebhookEventType(type) {
     return KNOWN_EVENT_TYPES.has(type);
 }
-/** Se este evento é a entrega de teste, e não um fato do acervo. */
 export function isWebhookTest(event) {
     return event.type === WEBHOOK_TEST_EVENT_TYPE;
 }
-/**
- * O status HTTP que cada recusa merece.
- *
- * A distinção que decide tudo é: o remetente deve voltar? Um corpo que não se
- * autentica nunca passará a se autenticar, e insistir só queima a curva de
- * reentrega — recusa definitiva. Já o segredo ausente é indisponibilidade
- * NOSSA: responder 4xx ali faz o motor desistir de uma entrega que a nossa
- * própria configuração derrubou, e o evento se perde para sempre.
- *
- * A regra é a mesma em todo receptor, então mora aqui em vez de ser reinventada
- * — com esse erro — em cada integração.
- */
 const REJECTION_STATUS = {
     MISSING_SECRET: 503,
     RAW_BODY_REQUIRED: 500,
@@ -167,17 +114,9 @@ const REJECTION_STATUS = {
 export function webhookRejectionStatus(reason) {
     return REJECTION_STATUS[reason];
 }
-/** Se a recusa é de responsabilidade do receptor, e o remetente deve voltar. */
 export function isReceiverFault(reason) {
     return REJECTION_STATUS[reason] >= 500;
 }
-/**
- * Confere a assinatura e devolve o evento tipado.
- *
- * A assinatura prova a ORIGEM; a conferência de forma que vem depois prova que
- * o corpo é um envelope de evento — sem ela, um corpo assinado mas malformado
- * viraria um `as` silencioso dentro do consumidor.
- */
 export function parseWebhookEvent(rawBody, headers, secret, options = {}) {
     const verification = verifyWebhookSignature(rawBody, headers, secret, options);
     if (!verification.ok)
@@ -201,10 +140,6 @@ export function parseWebhookEvent(rawBody, headers, secret, options = {}) {
     if (!body.payload || typeof body.payload !== "object") {
         return { ok: false, reason: "INVALID_ENVELOPE" };
     }
-    // O id é a chave de idempotência de todo receptor: uma entrega repetida é
-    // normal, e é por ele que ela se reconhece. Aceitá-lo vazio faria a primeira
-    // entrega sem id ocupar a única vaga de deduplicação e todas as seguintes
-    // parecerem repetição dela — um evento por conta, e o resto em silêncio.
     if (typeof body.id !== "string" || !body.id) {
         return { ok: false, reason: "INVALID_ENVELOPE" };
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lexnode/legal-data-sdk",
-  "version": "1.30.0",
+  "version": "1.31.0",
   "description": "Cliente TypeScript do LexNode, o motor de dados jur\u00eddicos do Brasil: transporte tipado, erros classificados, verifica\u00e7\u00e3o de webhook e os tipos gerados do contrato OpenAPI.",
   "license": "MIT",
   "homepage": "https://www.lexnode.com.br/docs",
@@ -39,10 +39,13 @@
   ],
   "sideEffects": false,
   "scripts": {
-    "build": "tsc -p tsconfig.json",
-    "prepack": "tsc -p tsconfig.json"
+    "clean": "rm -rf dist",
+    "build": "npm run clean && tsc -p tsconfig.json && tsc -p tsconfig.declarations.json && npm run test:package",
+    "test:package": "node --import ../test-isolation.mjs --test package.test.mjs",
+    "prepack": "npm run build"
   },
   "devDependencies": {
+    "typescript": "^5.9.3",
     "vitest": "^4.1.9"
   },
   "publishConfig": {