@vonpay/checkout-cli 0.20.0 → 0.21.0

package/dist/index.js

@@ -1358,7 +1358,7 @@ function parseMetadata(pairs) {
   return out;
 }
 var METADATA_FILTER_KEY = /^[A-Za-z0-9_.:-]{1,64}$/;
-var METADATA_FILTER_VALUE_MAX = 500;
+var METADATA_FILTER_VALUE_MAX = 128;
 function assertMetadataFilterKey(key, flag) {
   if (!METADATA_FILTER_KEY.test(key)) {
     throw new Error(
@@ -1378,6 +1378,41 @@ function parseMetadataFilter(raw, flag) {
   return { [key]: value };
 }
 
+// src/utils/processor-detail.ts
+import { SAFE_CODE_PATTERN, SAFE_CONNECTION_ID_PATTERN, safeValueOrWithheld } from "@vonpay/checkout-node";
+var INCLUDE_PROCESSOR_DETAIL_HELP = "With --json: also print the card processor's own answer (untrusted text), every try with its connection name, the connection's name, and the card's first six digits";
+var PROCESSOR_DETAIL_KEYS = ["processorResponse", "attempts", "attemptsStatus"];
+function cardForDisplay(card) {
+  if (card === null || typeof card !== "object" || Array.isArray(card)) return card;
+  const c = card;
+  return { brand: c.brand ?? null, last4: c.last4 ?? null };
+}
+function attemptSummary(a) {
+  return {
+    connectionId: safeValueOrWithheld(a.processorConnection?.id, SAFE_CONNECTION_ID_PATTERN),
+    result: safeValueOrWithheld(a.result, SAFE_CODE_PATTERN),
+    declineCode: safeValueOrWithheld(a.declineCode, SAFE_CODE_PATTERN),
+    outcome: safeValueOrWithheld(a.outcome, SAFE_CODE_PATTERN)
+  };
+}
+function attemptsStatusForDisplay(value) {
+  return safeValueOrWithheld(value, SAFE_CODE_PATTERN);
+}
+function connectionForDisplay(connection) {
+  if (connection === null || typeof connection !== "object" || Array.isArray(connection)) return connection;
+  return { id: connection.id ?? null };
+}
+function withoutProcessorDetail(obj, includeProcessorDetail) {
+  const src = obj;
+  if (includeProcessorDetail) return src;
+  const out = { ...src };
+  for (const k of PROCESSOR_DETAIL_KEYS) delete out[k];
+  if ("card" in out) out.card = cardForDisplay(out.card);
+  if ("processorConnection" in out) out.processorConnection = connectionForDisplay(out.processorConnection);
+  return out;
+}
+var PROCESSOR_DETAIL_NEEDS_JSON = "--include-processor-detail is used with --json.";
+
 // src/commands/payment-reports.ts
 import chalk8 from "chalk";
 import { formatMinorUnits as formatMinorUnits2 } from "@vonpay/checkout-node";
@@ -1430,12 +1465,24 @@ var PAYMENT_LIST_JSON_FIELDS = [
   "declineCode",
   "action",
   "ruleCode",
-  "networkAdvice"
+  "networkAdvice",
+  // Each try as the safe summary only (connection id, result, decline code, outcome), and
+  // whether that list is the full record. --include-processor-detail prints the whole tries.
+  "attempts",
+  "attemptsStatus"
 ];
-function listItemJson(pi, includeMetadata) {
-  if (includeMetadata) return pi;
+function listItemJson(pi, includeMetadata, includeProcessorDetail) {
   const src = pi;
-  return Object.fromEntries(PAYMENT_LIST_JSON_FIELDS.filter((k) => src[k] !== void 0).map((k) => [k, src[k]]));
+  const out = includeMetadata ? { ...src } : Object.fromEntries(PAYMENT_LIST_JSON_FIELDS.filter((k) => src[k] !== void 0).map((k) => [k, src[k]]));
+  if (includeProcessorDetail) {
+    if (src.processorResponse !== void 0) out.processorResponse = src.processorResponse;
+    return out;
+  }
+  const safe = withoutProcessorDetail(out, false);
+  if (src.attemptsStatus !== void 0) safe.attemptsStatus = attemptsStatusForDisplay(src.attemptsStatus);
+  if (pi.attempts === null) safe.attempts = null;
+  else if (Array.isArray(pi.attempts)) safe.attempts = pi.attempts.map(attemptSummary);
+  return safe;
 }
 var ALL_DEFAULT_MAX_ITEMS = 1e4;
 function stoppedAtDefaultCap() {
@@ -1450,6 +1497,7 @@ function buildListParams(opts) {
   if (opts.startingAfter !== void 0) params.startingAfter = opts.startingAfter;
   if (opts.maxItems !== void 0 && !opts.all) throw new Error("--max-items is used with --all.");
   if (opts.includeMetadata && !opts.json) throw new Error("--include-metadata is used with --json.");
+  if (opts.includeProcessorDetail && !opts.json) throw new Error(PROCESSOR_DETAIL_NEEDS_JSON);
   const maxItems = opts.maxItems !== void 0 ? positiveWholeNumber(opts.maxItems, "--max-items") : opts.all ? ALL_DEFAULT_MAX_ITEMS : void 0;
   return { params, ...maxItems !== void 0 ? { maxItems } : {} };
 }
@@ -1514,7 +1562,7 @@ var FILTER_HELP = {
   createdLt: "End of the window, exclusive (default: now). At most 31 days after the start (7 with summary --group-by hour)",
   outcome: "Only these outcomes, comma-separated (e.g. bank_declined,refused_before_bank)",
   store: "Only payments for this connected store hostname (e.g. shop.example.com)",
-  metadata: "Only payments with this metadata tag, key=value (ONE tag; key 1-64 of letters, digits, _ . : -; value 1-500 characters)",
+  metadata: "Only payments with this metadata tag, key=value (ONE tag; key 1-64 of letters, digits, _ . : -; value 1-128 characters)",
   cardBrand: "Only these card brands, comma-separated (visa, mastercard, amex, discover, unionpay, jcb, diners, unknown)",
   currency: "Only payments in this currency (e.g. USD)",
   initiator: "merchant (merchant-initiated charges on a saved card) or customer",
@@ -1541,7 +1589,7 @@ function addPaymentReportCommands(intents) {
   ).option("--max-items <n>", `With --all: stop after this many payments (default ${ALL_DEFAULT_MAX_ITEMS})`).option(
     "--json",
     "Output JSON: each payment's status, outcome, amount, card, store and decline fields \u2014 not your metadata (with --all: one JSON array)"
-  ).option("--include-metadata", "With --json: print every field of each payment, your metadata included").action(async (opts) => {
+  ).option("--include-metadata", "With --json: print every field of each payment, your metadata included (not the processor detail: see --include-processor-detail)").option("--include-processor-detail", INCLUDE_PROCESSOR_DETAIL_HELP).action(async (opts) => {
     let built;
     try {
       built = buildListParams(opts);
@@ -1558,7 +1606,7 @@ function addPaymentReportCommands(intents) {
         });
         if (opts.json) {
           const items = [];
-          for await (const pi of pager) items.push(listItemJson(pi, opts.includeMetadata));
+          for await (const pi of pager) items.push(listItemJson(pi, opts.includeMetadata, opts.includeProcessorDetail));
           spinner.stop();
           console.log(jsonOutput(items));
           if (opts.maxItems === void 0 && items.length >= ALL_DEFAULT_MAX_ITEMS) console.error(stoppedAtDefaultCap());
@@ -1579,7 +1627,12 @@ function addPaymentReportCommands(intents) {
       const page = await client.paymentIntents.list(built.params);
       spinner.stop();
       if (opts.json) {
-        console.log(jsonOutput({ ...page, data: page.data.map((pi) => listItemJson(pi, opts.includeMetadata)) }));
+        console.log(
+          jsonOutput({
+            ...page,
+            data: page.data.map((pi) => listItemJson(pi, opts.includeMetadata, opts.includeProcessorDetail))
+          })
+        );
         return;
       }
       for (const line of paymentListLines(page)) console.log(line);
@@ -1620,6 +1673,9 @@ function addPaymentReportCommands(intents) {
 }
 
 // src/commands/payment-intents.ts
+function refuseProcessorDetailWithoutJson(opts) {
+  if (opts.includeProcessorDetail && !opts.json) exitWithCliError(PROCESSOR_DETAIL_NEEDS_JSON, chalk9.red(PROCESSOR_DETAIL_NEEDS_JSON));
+}
 var MIT_INITIATORS = ["merchant", "customer"];
 var MIT_REASONS = [
   "recurring",
@@ -1755,7 +1811,8 @@ function paymentIntentsCommand() {
   ).option("--buyer-email <email>", "Buyer email for this charge").option(
     "--idempotency-key <key>",
     "Idempotency key for this charge. Reuse the SAME key to retry the same charge safely. REQUIRED on a live key; on a sandbox key generated (and printed) when omitted"
-  ).addOption(retiredConfirmLiveOption()).option("--json", "Output raw JSON").action(async (raw) => {
+  ).addOption(retiredConfirmLiveOption()).option("--json", "Output raw JSON").option("--include-processor-detail", INCLUDE_PROCESSOR_DETAIL_HELP).action(async (raw) => {
+    refuseProcessorDetailWithoutJson(raw);
     const apiKey = requireApiKey();
     const opts = { ...raw, amount: minorUnitsOrExit(raw.amount, "--amount") };
     const captureMethod = opts.captureMethod?.toLowerCase();
@@ -1797,7 +1854,7 @@ function paymentIntentsCommand() {
       });
       spinner.stop();
       if (opts.json) {
-        console.log(jsonOutput(intent));
+        console.log(jsonOutput(withoutProcessorDetail(intent, opts.includeProcessorDetail)));
       } else {
         console.log(chalk9.green("\u2713 Payment intent created"));
         printPaymentIntent(intent);
@@ -1809,14 +1866,15 @@ function paymentIntentsCommand() {
   });
   intents.command("get").description(
     "Read a payment intent back \u2014 the way to check a payment whose outcome was unclear before doing anything else"
-  ).argument("<id>", "Payment intent ID (vpi_*)").option("--json", "Output raw JSON").action(async (id, opts) => {
+  ).argument("<id>", "Payment intent ID (vpi_*)").option("--json", "Output raw JSON").option("--include-processor-detail", INCLUDE_PROCESSOR_DETAIL_HELP).action(async (id, opts) => {
+    refuseProcessorDetailWithoutJson(opts);
     const client = makeCheckoutClient();
     const spinner = startSpinner("Fetching payment intent...");
     try {
       const intent = await client.paymentIntents.retrieve(id);
       spinner.stop();
       if (opts.json) {
-        console.log(jsonOutput(intent));
+        console.log(jsonOutput(withoutProcessorDetail(intent, opts.includeProcessorDetail)));
       } else {
         printPaymentIntent(intent);
       }
@@ -1831,8 +1889,9 @@ function paymentIntentsCommand() {
   ).option(
     "--idempotency-key <key>",
     "Idempotency key. Reuse the SAME key to retry safely. REQUIRED on a live key; on a sandbox key generated (and printed) when omitted"
-  ).addOption(retiredConfirmLiveOption()).option("--json", "Output raw JSON").action(
+  ).addOption(retiredConfirmLiveOption()).option("--json", "Output raw JSON").option("--include-processor-detail", INCLUDE_PROCESSOR_DETAIL_HELP).action(
     async (id, opts) => {
+      refuseProcessorDetailWithoutJson(opts);
       const apiKey = requireApiKey();
       const amountToCapture = optionalMinorUnitsOrExit(
         opts.amountToCapture,
@@ -1866,7 +1925,7 @@ function paymentIntentsCommand() {
         );
         spinner.stop();
         if (opts.json) {
-          console.log(jsonOutput(intent));
+          console.log(jsonOutput(withoutProcessorDetail(intent, opts.includeProcessorDetail)));
         } else {
           const captureLabel = amountToCapture !== void 0 ? ` (partial: ${formatMinorUnits3(amountToCapture, intent.currency)})` : "";
           console.log(chalk9.green(`\u2713 Payment intent captured${captureLabel}`));
@@ -1881,8 +1940,9 @@ function paymentIntentsCommand() {
   intents.command("void").description("Void an authorized (uncaptured) payment intent").argument("<id>", "Payment intent ID (vpi_*)").option(
     "--idempotency-key <key>",
     "Idempotency key. Reuse the SAME key to retry safely. REQUIRED on a live key; on a sandbox key generated (and printed) when omitted"
-  ).addOption(retiredConfirmLiveOption()).option("--json", "Output raw JSON").action(
+  ).addOption(retiredConfirmLiveOption()).option("--json", "Output raw JSON").option("--include-processor-detail", INCLUDE_PROCESSOR_DETAIL_HELP).action(
     async (id, opts) => {
+      refuseProcessorDetailWithoutJson(opts);
       const apiKey = requireApiKey();
       refuseUnsafeLiveDestination(apiKey);
       const idempotencyKey = idempotencyKeyFor(opts.idempotencyKey, "void", apiKey);
@@ -1905,7 +1965,7 @@ function paymentIntentsCommand() {
         const intent = await client.paymentIntents.void(id, { idempotencyKey });
         spinner.stop();
         if (opts.json) {
-          console.log(jsonOutput(intent));
+          console.log(jsonOutput(withoutProcessorDetail(intent, opts.includeProcessorDetail)));
         } else {
           console.log(chalk9.green("\u2713 Payment intent voided"));
           printPaymentIntent(intent);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vonpay/checkout-cli",
-  "version": "0.20.0",
+  "version": "0.21.0",
   "description": "Von Payments CLI — developer tools for checkout integration",
   "repository": {
     "type": "git",
@@ -20,7 +20,7 @@
     "node": ">=20"
   },
   "dependencies": {
-    "@vonpay/checkout-node": "^4.8.0",
+    "@vonpay/checkout-node": "^4.9.0",
     "commander": "^13.0.0",
     "chalk": "^5.4.0",
     "ora": "^8.2.0"