@br-validators/cli 0.10.0-alpha.0 → 0.11.0-alpha.0

package/README.md

@@ -2,6 +2,8 @@
 
 Terminal CLI for all Brazilian document validators in [@br-validators/core](https://www.npmjs.com/package/@br-validators/core).
 
+**Repo:** [github.com/AlexandreZanata/br-validators](https://github.com/AlexandreZanata/br-validators)
+
 ---
 
 ## Install

package/dist/index.js

@@ -1,5 +1,4 @@
 #!/usr/bin/env node
-#!/usr/bin/env node
 
 // src/program.ts
 import { Command } from "commander";
@@ -7,22 +6,103 @@ import { Command } from "commander";
 // src/handlers.ts
 import { readFileSync } from "fs";
 
-// src/commands/cep.ts
+// src/commands/brcode.ts
 import {
-  CEP_OFFICIAL_SOURCE_URL,
-  formatCep,
-  stripCep,
-  validateCep
+  BRCODE_OFFICIAL_SOURCE_URL,
+  parseBrCode,
+  validateBrCode
 } from "@br-validators/core";
 
 // src/constants.ts
-var SUPPORTED_TYPES = ["cnpj", "cpf", "cep", "placa", "pis-pasep", "pix", "boleto", "cartao", "ie"];
+var SUPPORTED_TYPES = ["cnpj", "cpf", "cep", "telefone", "brcode", "placa", "pis-pasep", "pix", "boleto", "cartao", "ie"];
 var EXIT = {
   OK: 0,
   INVALID: 1,
   USAGE: 2
 };
 
+// src/commands/brcode.ts
+function resolveInput(value, fileContent) {
+  const input = value ?? fileContent?.trim();
+  if (!input) {
+    return null;
+  }
+  return input;
+}
+function printBrCodeResult(result, options, io = { stdout: [], stderr: [] }) {
+  if (options.json) {
+    io.stdout.push(
+      JSON.stringify(
+        result.ok ? {
+          ok: true,
+          value: result.value,
+          format: result.format,
+          merchantName: result.merchantName,
+          merchantCity: result.merchantCity,
+          ...result.amount ? { amount: result.amount } : {},
+          ...result.txid ? { txid: result.txid } : {},
+          ...result.pixKey ? { pixKey: result.pixKey, pixKeyType: result.pixKeyType } : {},
+          ...result.pixInitiationUrl ? { pixInitiationUrl: result.pixInitiationUrl } : {},
+          ...options.source ? { source: options.source } : {}
+        } : { ok: false, code: result.code, message: result.message },
+        null,
+        2
+      )
+    );
+    return result.ok ? EXIT.OK : EXIT.INVALID;
+  }
+  if (options.quiet) {
+    return result.ok ? EXIT.OK : EXIT.INVALID;
+  }
+  if (result.ok) {
+    io.stdout.push("valid: yes");
+    io.stdout.push(`merchantName: ${result.merchantName}`);
+    io.stdout.push(`merchantCity: ${result.merchantCity}`);
+    if (result.amount) {
+      io.stdout.push(`amount: ${result.amount}`);
+    }
+    if (result.txid) {
+      io.stdout.push(`txid: ${result.txid}`);
+    }
+    if (result.pixKey) {
+      io.stdout.push(`pixKey: ${result.pixKey}`);
+      io.stdout.push(`pixKeyType: ${result.pixKeyType}`);
+    }
+    if (result.pixInitiationUrl) {
+      io.stdout.push(`pixInitiationUrl: ${result.pixInitiationUrl}`);
+    }
+    if (options.source) {
+      io.stdout.push(`source: ${options.source}`);
+    }
+    return EXIT.OK;
+  }
+  io.stderr.push("valid: no");
+  io.stderr.push(`code: ${result.code}`);
+  io.stderr.push(`message: ${result.message}`);
+  return EXIT.INVALID;
+}
+function runBrCodeCommand(action, input, options, io = { stdout: [], stderr: [] }) {
+  const source = options.source ? BRCODE_OFFICIAL_SOURCE_URL : void 0;
+  const result = action === "validate" ? validateBrCode(input) : parseBrCode(input);
+  return printBrCodeResult(result, { json: options.json, quiet: options.quiet, source }, io);
+}
+function runBrCode(action, value, options, io = { stdout: [], stderr: [] }) {
+  const input = resolveInput(value, options.file);
+  if (input === null) {
+    io.stderr.push("Missing BR Code payload. Pass an argument or use --file.");
+    return EXIT.USAGE;
+  }
+  return runBrCodeCommand(action, input, options, io);
+}
+
+// src/commands/cep.ts
+import {
+  CEP_OFFICIAL_SOURCE_URL,
+  formatCep,
+  stripCep,
+  validateCep
+} from "@br-validators/core";
+
 // src/output.ts
 function printValidation(result, options, io = { stdout: [], stderr: [] }) {
   if (options.json) {
@@ -82,7 +162,7 @@ function printStrip(value, options, io = { stdout: [] }) {
 }
 
 // src/commands/cep.ts
-function resolveInput(value, fileContent) {
+function resolveInput2(value, fileContent) {
   const input = value ?? fileContent?.trim();
   if (!input) {
     return null;
@@ -106,7 +186,7 @@ function runCepCommand(action, input, options, io = { stdout: [], stderr: [] })
   }
 }
 function runCep(action, value, options, io = { stdout: [], stderr: [] }) {
-  const input = resolveInput(value, options.file);
+  const input = resolveInput2(value, options.file);
   if (input === null) {
     io.stderr.push("Missing CEP value. Pass an argument or use --file.");
     return EXIT.USAGE;
@@ -114,6 +194,79 @@ function runCep(action, value, options, io = { stdout: [], stderr: [] }) {
   return runCepCommand(action, input, options, io);
 }
 
+// src/commands/telefone.ts
+import {
+  TELEFONE_OFFICIAL_SOURCE_URL,
+  formatTelefone,
+  stripTelefone,
+  validateTelefone
+} from "@br-validators/core";
+function resolveInput3(value, fileContent) {
+  const input = value ?? fileContent?.trim();
+  if (!input) {
+    return null;
+  }
+  return input;
+}
+function printTelefoneValidation(result, options, io = { stdout: [], stderr: [] }) {
+  if (options.json) {
+    io.stdout.push(
+      JSON.stringify(
+        result.ok ? {
+          ok: true,
+          value: result.value,
+          tipo: result.tipo,
+          format: result.format,
+          ...options.source ? { source: options.source } : {}
+        } : { ok: false, code: result.code, message: result.message },
+        null,
+        2
+      )
+    );
+    return result.ok ? EXIT.OK : EXIT.INVALID;
+  }
+  if (options.quiet) {
+    return result.ok ? EXIT.OK : EXIT.INVALID;
+  }
+  if (result.ok) {
+    io.stdout.push(`valid: yes (${result.tipo})`);
+    io.stdout.push(`value: ${result.value}`);
+    io.stdout.push(`format: ${result.format}`);
+    if (options.source) {
+      io.stdout.push(`source: ${options.source}`);
+    }
+    return EXIT.OK;
+  }
+  io.stderr.push("valid: no");
+  io.stderr.push(`code: ${result.code}`);
+  io.stderr.push(`message: ${result.message}`);
+  return EXIT.INVALID;
+}
+function runTelefoneCommand(action, input, options, io = { stdout: [], stderr: [] }) {
+  const source = options.source ? TELEFONE_OFFICIAL_SOURCE_URL : void 0;
+  switch (action) {
+    case "validate":
+      return printTelefoneValidation(validateTelefone(input), { json: options.json, quiet: options.quiet, source }, io);
+    case "format":
+      return printFormat(formatTelefone(input), { json: options.json, quiet: options.quiet }, io);
+    case "strip":
+      return printStrip(stripTelefone(input), { json: options.json }, io);
+    default: {
+      const _exhaustive = action;
+      io.stderr.push(`Unknown action: ${_exhaustive}`);
+      return EXIT.USAGE;
+    }
+  }
+}
+function runTelefone(action, value, options, io = { stdout: [], stderr: [] }) {
+  const input = resolveInput3(value, options.file);
+  if (input === null) {
+    io.stderr.push("Missing telephone value. Pass an argument or use --file.");
+    return EXIT.USAGE;
+  }
+  return runTelefoneCommand(action, input, options, io);
+}
+
 // src/commands/cnpj.ts
 import {
   CNPJ_OFFICIAL_SOURCE_URL,
@@ -121,7 +274,7 @@ import {
   stripCnpj,
   validateCnpj
 } from "@br-validators/core";
-function resolveInput2(value, fileContent) {
+function resolveInput4(value, fileContent) {
   const input = value ?? fileContent?.trim();
   if (!input) {
     return null;
@@ -145,7 +298,7 @@ function runCnpjCommand(action, input, options, io = { stdout: [], stderr: [] })
   }
 }
 function runCnpj(action, value, options, io = { stdout: [], stderr: [] }) {
-  const input = resolveInput2(value, options.file);
+  const input = resolveInput4(value, options.file);
   if (input === null) {
     io.stderr.push("Missing CNPJ value. Pass an argument or use --file.");
     return EXIT.USAGE;
@@ -160,7 +313,7 @@ import {
   stripCpf,
   validateCpf
 } from "@br-validators/core";
-function resolveInput3(value, fileContent) {
+function resolveInput5(value, fileContent) {
   const input = value ?? fileContent?.trim();
   if (!input) {
     return null;
@@ -184,7 +337,7 @@ function runCpfCommand(action, input, options, io = { stdout: [], stderr: [] })
   }
 }
 function runCpf(action, value, options, io = { stdout: [], stderr: [] }) {
-  const input = resolveInput3(value, options.file);
+  const input = resolveInput5(value, options.file);
   if (input === null) {
     io.stderr.push("Missing CPF value. Pass an argument or use --file.");
     return EXIT.USAGE;
@@ -200,7 +353,7 @@ import {
   stripPlaca,
   validatePlaca
 } from "@br-validators/core";
-function resolveInput4(value, fileContent) {
+function resolveInput6(value, fileContent) {
   const input = value ?? fileContent?.trim();
   if (!input) {
     return null;
@@ -226,7 +379,7 @@ function runPlacaCommand(action, input, options, io = { stdout: [], stderr: [] }
   }
 }
 function runPlaca(action, value, options, io = { stdout: [], stderr: [] }) {
-  const input = resolveInput4(value, options.file);
+  const input = resolveInput6(value, options.file);
   if (input === null) {
     io.stderr.push("Missing placa value. Pass an argument or use --file.");
     return EXIT.USAGE;
@@ -241,7 +394,7 @@ import {
   stripPisPasep,
   validatePisPasep
 } from "@br-validators/core";
-function resolveInput5(value, fileContent) {
+function resolveInput7(value, fileContent) {
   const input = value ?? fileContent?.trim();
   if (!input) {
     return null;
@@ -265,7 +418,7 @@ function runPisPasepCommand(action, input, options, io = { stdout: [], stderr: [
   }
 }
 function runPisPasep(action, value, options, io = { stdout: [], stderr: [] }) {
-  const input = resolveInput5(value, options.file);
+  const input = resolveInput7(value, options.file);
   if (input === null) {
     io.stderr.push("Missing PIS/PASEP value. Pass an argument or use --file.");
     return EXIT.USAGE;
@@ -280,7 +433,7 @@ import {
   formatPixKey,
   validatePixKey
 } from "@br-validators/core";
-function resolveInput6(value, fileContent) {
+function resolveInput8(value, fileContent) {
   const input = value ?? fileContent?.trim();
   if (!input) {
     return null;
@@ -355,7 +508,7 @@ function runPixCommand(action, input, options, io = { stdout: [], stderr: [] })
   }
 }
 function runPix(action, value, options, io = { stdout: [], stderr: [] }) {
-  const input = resolveInput6(value, options.file);
+  const input = resolveInput8(value, options.file);
   if (input === null) {
     io.stderr.push("Missing PIX key value. Pass an argument or use --file.");
     return EXIT.USAGE;
@@ -374,7 +527,7 @@ import {
   stripLinhaDigitavel,
   validateBoleto
 } from "@br-validators/core";
-function resolveInput7(value, fileContent) {
+function resolveInput9(value, fileContent) {
   const input = value ?? fileContent?.trim();
   if (!input) {
     return null;
@@ -498,7 +651,7 @@ function runBoletoCommand(action, input, options, direction, io = { stdout: [],
   }
 }
 function runBoleto(action, value, options, direction, io = { stdout: [], stderr: [] }) {
-  const input = resolveInput7(value, options.file);
+  const input = resolveInput9(value, options.file);
   if (input === null) {
     io.stderr.push("Missing boleto value. Pass an argument or use --file.");
     return EXIT.USAGE;
@@ -514,7 +667,7 @@ import {
   stripCartaoCredito,
   validateCartaoCredito
 } from "@br-validators/core";
-function resolveInput8(value, fileContent) {
+function resolveInput10(value, fileContent) {
   const input = value ?? fileContent?.trim();
   if (!input) {
     return null;
@@ -590,7 +743,7 @@ function runCartaoCommand(action, input, options, io = { stdout: [], stderr: []
   }
 }
 function runCartao(action, value, options, io = { stdout: [], stderr: [] }) {
-  const input = resolveInput8(value, options.file);
+  const input = resolveInput10(value, options.file);
   if (input === null) {
     io.stderr.push("Missing credit card PAN value. Pass an argument or use --file.");
     return EXIT.USAGE;
@@ -606,7 +759,7 @@ import {
   stripInscricaoEstadual,
   validateInscricaoEstadual
 } from "@br-validators/core";
-function resolveInput9(value, fileContent) {
+function resolveInput11(value, fileContent) {
   const input = value ?? fileContent?.trim();
   if (!input) {
     return null;
@@ -687,7 +840,7 @@ function runIeCommand(action, input, options, io = { stdout: [], stderr: [] }) {
   }
 }
 function runIe(action, value, options, io = { stdout: [], stderr: [] }) {
-  const input = resolveInput9(value, options.file);
+  const input = resolveInput11(value, options.file);
   if (input === null) {
     io.stderr.push("Missing IE value. Pass an argument or use --file.");
     return EXIT.USAGE;
@@ -778,6 +931,27 @@ function handleCepCli(action, value, opts, io = { stdout: [], stderr: [] }) {
     io
   );
 }
+function handleTelefoneCli(action, value, opts, io = { stdout: [], stderr: [] }) {
+  let fileContent;
+  if (opts.file) {
+    const content = readInputFile(opts.file, io);
+    if (content === null) {
+      return EXIT.USAGE;
+    }
+    fileContent = content;
+  }
+  return runTelefone(
+    action,
+    value,
+    {
+      json: Boolean(opts.json),
+      quiet: Boolean(opts.quiet),
+      source: Boolean(opts.source),
+      file: fileContent
+    },
+    io
+  );
+}
 function handlePlacaCli(action, value, opts, io = { stdout: [], stderr: [] }) {
   let fileContent;
   if (opts.file) {
@@ -907,6 +1081,27 @@ function handleCartaoCreditoCli(action, value, opts, io = { stdout: [], stderr:
     io
   );
 }
+function handleBrCodeCli(action, value, opts, io = { stdout: [], stderr: [] }) {
+  let fileContent;
+  if (opts.file) {
+    const content = readInputFile(opts.file, io);
+    if (content === null) {
+      return EXIT.USAGE;
+    }
+    fileContent = content;
+  }
+  return runBrCode(
+    action,
+    value,
+    {
+      json: Boolean(opts.json),
+      quiet: Boolean(opts.quiet),
+      source: Boolean(opts.source),
+      file: fileContent
+    },
+    io
+  );
+}
 function handleIeCli(action, value, opts, io = { stdout: [], stderr: [] }) {
   let fileContent;
   if (opts.file) {
@@ -967,6 +1162,22 @@ function createProgram() {
       writeCliIo(io);
     });
   }
+  const telefone = program.command("telefone").description("Telefone \u2014 Brazilian fixo/celular (Anatel DDD)");
+  for (const action of ["validate", "format", "strip"]) {
+    telefone.command(action).description(`${action} a Brazilian telephone number`).argument("[value]", "Telephone value (raw or masked)").option("--json", "JSON output").option("-q, --quiet", "Exit code only").option("--source", "Include official source URL (validate only)").option("-f, --file <path>", "Read value from file").action((value, opts) => {
+      const io = { stdout: [], stderr: [] };
+      process.exitCode = handleTelefoneCli(action, value, opts, io);
+      writeCliIo(io);
+    });
+  }
+  const brcode = program.command("brcode").description("BR Code \u2014 PIX QR payload (Bacen EMV TLV)");
+  for (const action of ["parse", "validate"]) {
+    brcode.command(action).description(`${action} a BR Code payload`).argument("[value]", "BR Code payload (Pix Copia e Cola)").option("--json", "JSON output").option("-q, --quiet", "Exit code only").option("--source", "Include official source URL").option("-f, --file <path>", "Read value from file").action((value, opts) => {
+      const io = { stdout: [], stderr: [] };
+      process.exitCode = handleBrCodeCli(action, value, opts, io);
+      writeCliIo(io);
+    });
+  }
   const placa = program.command("placa").description("Placa \u2014 legacy + Mercosul (CONTRAN)");
   for (const action of ["validate", "format", "strip", "convert"]) {
     placa.command(action).description(`${action} a license plate`).argument("[value]", "Placa value (raw or masked)").option("--json", "JSON output").option("-q, --quiet", "Exit code only").option("--source", "Include official source URL (validate only)").option("-f, --file <path>", "Read value from file").action((value, opts) => {

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "@br-validators/cli",
-  "version": "0.10.0-alpha.0",
+  "version": "0.11.0-alpha.0",
   "description": "Terminal CLI for Brazilian document validation — CPF, CNPJ, CEP, IE, PIX, boleto, and more",
   "license": "MIT",
   "type": "module",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/AlexandreZanata/doc-raiz.git",
+    "url": "git+https://github.com/AlexandreZanata/br-validators.git",
     "directory": "apps/cli"
   },
-  "homepage": "https://github.com/AlexandreZanata/doc-raiz#readme",
+  "homepage": "https://github.com/AlexandreZanata/br-validators/tree/main/apps/cli#readme",
   "bugs": {
-    "url": "https://github.com/AlexandreZanata/doc-raiz/issues"
+    "url": "https://github.com/AlexandreZanata/br-validators/issues"
   },
   "keywords": [
     "brazil",
@@ -21,14 +21,15 @@
     "cnpj"
   ],
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "tag": "alpha"
   },
   "bin": {
-    "br-validators": "./dist/index.js"
+    "br-validators": "dist/index.js"
   },
   "dependencies": {
     "commander": "^13.1.0",
-    "@br-validators/core": "0.10.0-alpha.0"
+    "@br-validators/core": "0.11.0-alpha.0"
   },
   "devDependencies": {
     "@types/node": "^22.15.21",
@@ -43,6 +44,8 @@
   ],
   "scripts": {
     "build": "tsup",
+    "pretest": "pnpm run build",
+    "pretest:coverage": "pnpm run build",
     "pretypecheck": "pnpm --filter @br-validators/core build",
     "test": "vitest run",
     "test:coverage": "vitest run --coverage",