@visa/cli 4.1.0-rc.13 → 4.1.0-rc.131

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (63) hide show
  1. package/README.md +188 -232
  2. package/dist/checkout-engine/adapters/generic.d.ts +4 -0
  3. package/dist/checkout-engine/adapters/generic.js +28 -13
  4. package/dist/checkout-engine/adapters/index.d.ts +4 -1
  5. package/dist/checkout-engine/adapters/index.js +10 -3
  6. package/dist/checkout-engine/adapters/shopify.d.ts +31 -0
  7. package/dist/checkout-engine/adapters/shopify.js +423 -0
  8. package/dist/checkout-engine/amount.d.ts +15 -0
  9. package/dist/checkout-engine/amount.js +72 -0
  10. package/dist/checkout-engine/cli-engine.d.ts +207 -2
  11. package/dist/checkout-engine/cli-engine.js +677 -27
  12. package/dist/checkout-engine/detect.d.ts +1 -1
  13. package/dist/checkout-engine/detect.js +26 -0
  14. package/dist/checkout-engine/evidence.d.ts +4 -1
  15. package/dist/checkout-engine/evidence.js +51 -6
  16. package/dist/checkout-engine/executor.d.ts +34 -4
  17. package/dist/checkout-engine/executor.js +266 -115
  18. package/dist/checkout-engine/hosted-approval.d.ts +133 -8
  19. package/dist/checkout-engine/hosted-approval.js +400 -49
  20. package/dist/checkout-engine/index.d.ts +4 -1
  21. package/dist/checkout-engine/index.js +3 -0
  22. package/dist/checkout-engine/instrument.d.ts +7 -0
  23. package/dist/checkout-engine/instrument.js +4 -0
  24. package/dist/checkout-engine/live-fill-approval.d.ts +0 -20
  25. package/dist/checkout-engine/live-fill-approval.js +15 -51
  26. package/dist/checkout-engine/mandate/card-mandate.d.ts +121 -0
  27. package/dist/checkout-engine/mandate/card-mandate.js +227 -0
  28. package/dist/checkout-engine/mandate/mandate-ledger.d.ts +165 -0
  29. package/dist/checkout-engine/mandate/mandate-ledger.js +373 -0
  30. package/dist/checkout-engine/outcome.d.ts +2 -2
  31. package/dist/checkout-engine/outcome.js +36 -1
  32. package/dist/checkout-engine/owner-only-file.d.ts +9 -0
  33. package/dist/checkout-engine/owner-only-file.js +20 -1
  34. package/dist/checkout-engine/trace-handles.d.ts +8 -0
  35. package/dist/checkout-engine/trace-handles.js +12 -0
  36. package/dist/checkout-engine/types.d.ts +20 -2
  37. package/dist/checkout-engine/vgs-gateway/server-mint-client.d.ts +82 -0
  38. package/dist/checkout-engine/vgs-gateway/server-mint-client.js +180 -0
  39. package/dist/checkout-engine/vgs-live-instrument.d.ts +38 -0
  40. package/dist/checkout-engine/vgs-live-instrument.js +52 -8
  41. package/dist/checkout-engine/vic-confirmation.js +2 -2
  42. package/dist/cli.js +580 -494
  43. package/dist/mcp-server/index.js +442 -176
  44. package/dist/skills/pair-visa-agent/RUNTIMES.md +92 -0
  45. package/dist/skills/pair-visa-agent/SKILL.md +467 -0
  46. package/dist/skills/pair-visa-agent/scripts/setup.mjs +48 -0
  47. package/install.ps1 +3 -41
  48. package/install.sh +4 -36
  49. package/native/bin/win32-x64/visa-keychain-win.exe +0 -0
  50. package/package.json +16 -12
  51. package/server.json +3 -3
  52. package/dist/checkout-engine/inline-target.d.ts +0 -13
  53. package/dist/checkout-engine/inline-target.js +0 -37
  54. package/dist/checkout-engine/pay-args.d.ts +0 -14
  55. package/dist/checkout-engine/pay-args.js +0 -44
  56. package/dist/checkout-engine/pay.d.ts +0 -1
  57. package/dist/checkout-engine/pay.js +0 -13
  58. package/dist/checkout-engine/repo-env.d.ts +0 -11
  59. package/dist/checkout-engine/repo-env.js +0 -23
  60. package/dist/checkout-engine/run-live-fill.d.ts +0 -1
  61. package/dist/checkout-engine/run-live-fill.js +0 -443
  62. package/dist/checkout-engine/vgs-gateway/fetch-credential.d.mts +0 -74
  63. package/dist/checkout-engine/vgs-gateway/fetch-credential.mjs +0 -240
@@ -1,18 +1,19 @@
1
1
  // Deliberate-enablement seam for run-live-fill's submit mode. A real submit
2
2
  // moves real money, so it requires:
3
- // 1. an interactive human at a real TTY — or, for scripted/agent runs,
4
- // the explicit CHECKOUT_AGENT_ALLOW_SUBMIT=1 environment arm,
5
- // 2. the invocation opts in (--mode submit, or the CHECKOUT_AGENT_MODE
3
+ // 1. the invocation opts in (--mode submit, or the CHECKOUT_AGENT_MODE
6
4
  // environment default for operators who always run one mode),
7
- // 3. the operator types the PAY phrase against the exact review id (and a
5
+ // 2. the operator types the PAY phrase against the exact review id (and a
8
6
  // hosted run additionally requires the passkey tap on the verify site).
9
- // The env arm is an anti-automation gate, not a human ritual: a TTY human's
10
- // consent is act 3 the PAY phrase differs from dry-run's FILL phrase, so a
11
- // muscle-memory rerun of the dry-run procedure still cannot drift into
12
- // charging a card — while a non-interactive caller (script, agent, pipe) can
13
- // fake neither the phrase's review id nor the FIDO ceremony and must also be
14
- // explicitly armed. Fresh checkouts therefore need ZERO persisted config.
15
- export const SUBMIT_ENV_FLAG = 'CHECKOUT_AGENT_ALLOW_SUBMIT';
7
+ // The PAY phrase differs from dry-run's FILL phrase and names the exact review
8
+ // id, so a muscle-memory rerun of the dry-run procedure cannot drift into
9
+ // charging a card. Fresh checkouts need ZERO persisted config.
10
+ //
11
+ // There was a third requirement a CHECKOUT_AGENT_ALLOW_SUBMIT=1 environment
12
+ // arm, exempted for interactive TTYs meant to stop AUTOMATION reaching a live
13
+ // charge. It never ran: nothing in the product ever called `assertSubmitAllowed`.
14
+ // The same flag DID gate `pay_merchant`, where being default-off with no
15
+ // in-product way to set it meant a real install could not complete a purchase at
16
+ // all. Both are gone; the phrase and the mandate caps are the gates.
16
17
  export const MODE_ENV_FLAG = 'CHECKOUT_AGENT_MODE';
17
18
  /**
18
19
  * `--mode` values map 1:1 onto CheckoutMode; an absent flag falls back to the
@@ -26,46 +27,9 @@ export function parseCheckoutMode(value, env = process.env) {
26
27
  return 'submit';
27
28
  throw new Error(`--mode (or ${MODE_ENV_FLAG}) must be dry-run or submit (got ${JSON.stringify(effective)})`);
28
29
  }
29
- /**
30
- * Fail fast (before any file read or browser launch) when submit lacks an
31
- * enablement. The env arm exists to stop AUTOMATION from reaching a live
32
- * charge by accident — so it is required only when stdin is not a real TTY
33
- * (scripts, agents, pipes). An interactive human needs no standing config:
34
- * their per-run consent is the typed PAY phrase plus the passkey tap, both of
35
- * which a non-interactive caller cannot fake (the phrase names the exact
36
- * review id; the passkey is a FIDO ceremony on the verify site).
37
- */
38
- export function assertSubmitAllowed(mode, env = process.env, isInteractive = process.stdin.isTTY === true) {
39
- if (mode !== 'submit')
40
- return;
41
- if (env[SUBMIT_ENV_FLAG] === '1')
42
- return;
43
- if (isInteractive)
44
- return;
45
- throw new Error(`--mode submit refused: this is not an interactive terminal, and scripted submits ` +
46
- `require ${SUBMIT_ENV_FLAG}=1. The gate is default-off so automation cannot ` +
47
- 'reach a live charge by accident.');
48
- }
49
- export const LEGACY_REFERENCE_ENV_FLAG = 'CHECKOUT_AGENT_ALLOW_LEGACY_REFERENCE';
50
- /**
51
- * The legacy --reference-file path replays a PRE-CREATED intent, so the
52
- * purchase-assurance gate (#5709) cannot vet the ceremony that backed it —
53
- * scope/freshness problems surface only as the opaque cryptogram failure the
54
- * gate exists to prevent. Default-off escape hatch, same shape as the submit
55
- * gate: fail fast before any file is read.
56
- */
57
- export function assertLegacyReferenceAllowed(usingReferenceFile, env = process.env) {
58
- if (!usingReferenceFile)
59
- return;
60
- if (env[LEGACY_REFERENCE_ENV_FLAG] !== '1') {
61
- throw new Error(`--reference-file refused: this legacy path bypasses purchase-assurance validation ` +
62
- `(#5709) — prefer --checkout-file with --purchase-assurance-file. Set ` +
63
- `${LEGACY_REFERENCE_ENV_FLAG}=1 to proceed anyway.`);
64
- }
65
- }
66
30
  /** Distinct phrases per mode so dry-run muscle memory can never authorize a payment. */
67
31
  export function approvalPhrase(mode, reviewId) {
68
- return `${mode === 'submit' ? 'PAY' : 'FILL'} ${reviewId}`;
32
+ return `${mode === 'submit' ? 'PAY' : 'CHECK'} ${reviewId}`;
69
33
  }
70
34
  /** Integer-only minor→display formatting (two-decimal currencies, the same assumption as decimalToMinor). */
71
35
  export function formatAmountMinor(amountMinor, currency) {
@@ -79,11 +43,11 @@ export function approvalQuestion(mode, review, phrase) {
79
43
  `Type ${JSON.stringify(phrase)} to disclose the credential AND submit the order: `);
80
44
  }
81
45
  return (`Inspect the visible checkout. Type ${JSON.stringify(phrase)} ` +
82
- `to disclose the credential to this page without submitting: `);
46
+ `to validate the reviewed page without minting, filling, or submitting a credential: `);
83
47
  }
84
48
  /** The one outcome each mode may exit 0 with. */
85
49
  export function isRunSuccess(mode, outcome) {
86
- return outcome === (mode === 'submit' ? 'confirmed' : 'filled-dry-run');
50
+ return outcome === (mode === 'submit' ? 'confirmed' : 'reviewed-dry-run');
87
51
  }
88
52
  /**
89
53
  * True when the pay control was actually clicked but the run ended with an
@@ -0,0 +1,121 @@
1
+ import { type VgsCheckoutTarget, type VgsPaymentCredential } from '../vgs-live-instrument.js';
2
+ import { MandateLedger } from './mandate-ledger.js';
3
+ /**
4
+ * Default number of draws a ceiling intent may fulfil (VGS mandate quantity).
5
+ * This is a purchase-COUNT cap, NOT the exposure bound: VGS enforces the
6
+ * declineThreshold as a CUMULATIVE cap across draws (live-verified 2026-07-23),
7
+ * so the total the network will authorize is the ceiling REGARDLESS of how many
8
+ * draws it is spread across — maxDraws only limits the number of separate
9
+ * purchases, it does not multiply the exposure. Kept SMALL as a sensible default
10
+ * purchase count (the owner-side client ledger also caps cumulative spend at ONE
11
+ * ceiling). This is the single default; callers that don't set maxDraws inherit
12
+ * it (do not re-duplicate it upstream).
13
+ */
14
+ export declare const DEFAULT_MANDATE_MAX_DRAWS = 3;
15
+ export type CardMandateMerchant = {
16
+ name: string;
17
+ url: string;
18
+ countryCode: string;
19
+ };
20
+ export type CreateCardMandateInput = {
21
+ /** Exact current runtime request key selected before human approval. */
22
+ agentJkt: string;
23
+ tokenId: string;
24
+ assuranceData: unknown;
25
+ ceilingMinor: number;
26
+ merchant: CardMandateMerchant;
27
+ currencyCode: string;
28
+ expiresAt: string;
29
+ /** Max draws the ceiling intent may fulfil; defaults to DEFAULT_MANDATE_MAX_DRAWS. */
30
+ maxDraws?: number;
31
+ /** Cross-host retail budget; network category eligibility still applies. */
32
+ crossMerchant?: boolean;
33
+ };
34
+ export type CreateIntentFn = (input: {
35
+ tokenId: string;
36
+ assuranceData: unknown;
37
+ transaction: VgsCheckoutTarget;
38
+ mandate: {
39
+ declineThresholdAmount: string;
40
+ quantity: number;
41
+ effectiveUntil: string;
42
+ consumerPrompt: string;
43
+ };
44
+ }) => Promise<{
45
+ intentId: string;
46
+ status: string | null;
47
+ }>;
48
+ export type CreateCardMandateDeps = {
49
+ /** Mint the ceiling intent — wire serverCreateIntent(base, mintToken, …). */
50
+ createIntent: CreateIntentFn;
51
+ ledger: MandateLedger;
52
+ /** verify-web origin the intent is minted against (persisted for later draws). */
53
+ approvalBaseUrl: string;
54
+ /** Scoped mint token to persist for tap-free draws. */
55
+ mintToken?: string;
56
+ now?: () => Date;
57
+ };
58
+ export type CardMandateFacts = {
59
+ mandateId: string;
60
+ ceilingMinor: number;
61
+ remainingMinor: number;
62
+ currencyCode: string;
63
+ merchant: CardMandateMerchant;
64
+ expiresAt: string;
65
+ /** Network-enforced maximum purchase count disclosed at approval. */
66
+ maxDraws: number;
67
+ };
68
+ /**
69
+ * Create a card mandate: approve a spend CEILING once (the passkey assurance
70
+ * passed here was scoped to the ceiling + merchant), mint one VGS intent with
71
+ * that ceiling as its decline threshold, and record the cumulative-budget
72
+ * ledger entry. Integer minor units only.
73
+ */
74
+ export declare function createCardMandate(input: CreateCardMandateInput, deps: CreateCardMandateDeps): Promise<CardMandateFacts>;
75
+ export type FetchCryptogramFn = (input: {
76
+ tokenId: string;
77
+ intentId: string;
78
+ transaction: VgsCheckoutTarget;
79
+ }) => Promise<VgsPaymentCredential>;
80
+ export type DrawFromMandateInput = {
81
+ mandateId: string;
82
+ amountMinor: number;
83
+ /** The exact per-draw checkout target (merchant + amount + currency). */
84
+ transaction: VgsCheckoutTarget;
85
+ };
86
+ export type DrawFromMandateDeps = {
87
+ /** Draw a cryptogram against the mandate intent — wire serverFetchCryptogram. */
88
+ fetchCryptogram: FetchCryptogramFn;
89
+ ledger: MandateLedger;
90
+ /** Override the payable-credential gate (default validateCredential). */
91
+ validate?: (credential: VgsPaymentCredential) => void;
92
+ now?: () => Date;
93
+ };
94
+ export type DrawResult = {
95
+ payment: VgsPaymentCredential;
96
+ intentId: string;
97
+ remainingMinor: number;
98
+ };
99
+ /**
100
+ * Thrown ONLY for the post-reservation network/validation rejection class — the
101
+ * cryptogram fetch failed or returned a non-payable credential (the DRAW_REMEDY
102
+ * path). This is the sole draw failure that should DISABLE the mandate: it means
103
+ * the acquirer would not honor a ceiling-scoped assurance for a sub-amount draw.
104
+ *
105
+ * Pre-network failures — a fail-closed `reserve()` (concurrent over-budget race
106
+ * or expiry) or a `commit()` file-I/O error — throw a plain Error instead, so
107
+ * the caller (cli-engine) can rethrow them WITHOUT marking a HEALTHY mandate
108
+ * unhonored. Discriminating on this type is what keeps a transient race from
109
+ * permanently disabling a good mandate (michaelyang1 M1).
110
+ */
111
+ export declare class MandateDrawDeclinedError extends Error {
112
+ readonly cause?: unknown;
113
+ constructor(message: string, cause?: unknown);
114
+ }
115
+ /**
116
+ * Draw a cryptogram against an existing card mandate with NO fresh tap. The
117
+ * reservation is atomic and the budget is decremented ONLY after a payable
118
+ * cryptogram returns; any rejection releases the reservation so remaining is
119
+ * unchanged. Validates merchant + currency + amount against the mandate first.
120
+ */
121
+ export declare function drawFromMandate(input: DrawFromMandateInput, deps: DrawFromMandateDeps): Promise<DrawResult>;
@@ -0,0 +1,227 @@
1
+ // Card mandate (budget) layer — the split the north-star card flow needs:
2
+ //
3
+ // BUDGET = start_card_mandate: approve a CEILING once with the passkey. This
4
+ // mints ONE VGS intent whose decline threshold is the ceiling (not
5
+ // amount+10) and whose quantity permits many draws. The passkey
6
+ // assurance is scoped to the ceiling + merchant, not one charge.
7
+ // DRAW = pay_merchant (tap-free): pull a cryptogram against that intent for
8
+ // an in-budget purchase, WITHOUT a fresh tap, and decrement the
9
+ // cumulative budget in the owner-only ledger.
10
+ //
11
+ // This mirrors x402's start_session -> wallet_pay shape on the card rail.
12
+ //
13
+ // PROVEN (live probe 2026-07-23): VGS honors a ceiling-scoped assurance across
14
+ // multiple sub-amount cryptogram draws against one intent, AND enforces the
15
+ // decline threshold as a CUMULATIVE cap — draws summing to the ceiling are
16
+ // payable, the next draw over the cumulative ceiling is declined. So the total
17
+ // the network authorizes is the ceiling, not maxDraws × ceiling. drawFromMandate
18
+ // stays FAIL-CLEAN as defense-in-depth: the budget is decremented only after a
19
+ // payable cryptogram returns; a network rejection leaves the budget untouched.
20
+ // The caller (cli-engine) then marks the mandate unhonored so the NEXT
21
+ // pay_merchant skips it and takes a fresh per-purchase tap — the same call is
22
+ // not retried in-flight. Never fail-open.
23
+ import { decimalToMinor, minorToDecimal, validateCredential, } from '../vgs-live-instrument.js';
24
+ import { CARD_MANDATE_LEDGER_VERSION, remainingMinor, } from './mandate-ledger.js';
25
+ /**
26
+ * Default number of draws a ceiling intent may fulfil (VGS mandate quantity).
27
+ * This is a purchase-COUNT cap, NOT the exposure bound: VGS enforces the
28
+ * declineThreshold as a CUMULATIVE cap across draws (live-verified 2026-07-23),
29
+ * so the total the network will authorize is the ceiling REGARDLESS of how many
30
+ * draws it is spread across — maxDraws only limits the number of separate
31
+ * purchases, it does not multiply the exposure. Kept SMALL as a sensible default
32
+ * purchase count (the owner-side client ledger also caps cumulative spend at ONE
33
+ * ceiling). This is the single default; callers that don't set maxDraws inherit
34
+ * it (do not re-duplicate it upstream).
35
+ */
36
+ export const DEFAULT_MANDATE_MAX_DRAWS = 3;
37
+ function assertPositiveInteger(value, label) {
38
+ if (!Number.isSafeInteger(value) || value <= 0) {
39
+ throw new Error(`${label} must be a positive integer (minor units)`);
40
+ }
41
+ }
42
+ function merchantHost(url) {
43
+ try {
44
+ return new URL(url).hostname;
45
+ }
46
+ catch {
47
+ throw new Error(`mandate merchant URL is invalid: ${url}`);
48
+ }
49
+ }
50
+ /**
51
+ * Create a card mandate: approve a spend CEILING once (the passkey assurance
52
+ * passed here was scoped to the ceiling + merchant), mint one VGS intent with
53
+ * that ceiling as its decline threshold, and record the cumulative-budget
54
+ * ledger entry. Integer minor units only.
55
+ */
56
+ export async function createCardMandate(input, deps) {
57
+ assertPositiveInteger(input.ceilingMinor, 'mandate ceiling');
58
+ const currencyCode = String(input.currencyCode).toUpperCase();
59
+ if (!/^[A-Z]{3}$/.test(currencyCode)) {
60
+ throw new Error('mandate currency must be a 3-letter ISO 4217 code');
61
+ }
62
+ if (!input.tokenId?.trim())
63
+ throw new Error('mandate requires a tokenId');
64
+ if (!/^[A-Za-z0-9_-]{42}[AEIMQUYcgkosw048]$/.test(input.agentJkt)) {
65
+ throw new Error('mandate requires a canonical agent request-key JKT');
66
+ }
67
+ const now = (deps.now ?? (() => new Date()))();
68
+ const expiryMs = Date.parse(input.expiresAt);
69
+ if (!Number.isFinite(expiryMs))
70
+ throw new Error('mandate expiresAt must be ISO 8601');
71
+ if (expiryMs <= now.getTime())
72
+ throw new Error('mandate expiresAt is already in the past');
73
+ const host = merchantHost(input.merchant.url);
74
+ const maxDraws = input.maxDraws ?? DEFAULT_MANDATE_MAX_DRAWS;
75
+ if (!Number.isSafeInteger(maxDraws) || maxDraws < 1) {
76
+ throw new Error('mandate maxDraws must be a positive integer');
77
+ }
78
+ // Pass the currency so a non-2-decimal currency is REFUSED here rather than
79
+ // silently rendered with a wrong wire amount (minorToDecimal assumes /100).
80
+ const ceilingDecimal = minorToDecimal(input.ceilingMinor, currencyCode);
81
+ // The passkey prompt must state the REAL grant. VGS enforces the
82
+ // declineThreshold as a CUMULATIVE cap across draws (live-verified 2026-07-23),
83
+ // so the total this single approval can authorize is the CEILING — not
84
+ // maxDraws × ceiling. maxDraws only caps how many separate purchases the intent
85
+ // may fulfil. The prompt therefore names the ceiling as the total and maxDraws
86
+ // as the purchase-count limit (H1: consent must match the true grant).
87
+ // The intent transaction is scoped to the CEILING itself: the decline
88
+ // threshold IS the ceiling (not the historical ceil(amount)+10), and quantity
89
+ // permits multiple draws.
90
+ const ceilingTarget = {
91
+ merchantName: input.merchant.name,
92
+ merchantUrl: input.merchant.url,
93
+ merchantCountryCode: input.merchant.countryCode.toUpperCase(),
94
+ transactionAmount: ceilingDecimal,
95
+ transactionCurrencyCode: currencyCode,
96
+ };
97
+ const { intentId } = await deps.createIntent({
98
+ tokenId: input.tokenId,
99
+ assuranceData: input.assuranceData,
100
+ transaction: ceilingTarget,
101
+ mandate: {
102
+ declineThresholdAmount: ceilingDecimal,
103
+ quantity: maxDraws,
104
+ effectiveUntil: new Date(expiryMs).toISOString(),
105
+ consumerPrompt: `Approve up to ${ceilingDecimal} ${currencyCode} total (across up to ` +
106
+ `${maxDraws} purchase${maxDraws === 1 ? '' : 's'}) at ${input.merchant.name} ` +
107
+ `for my Visa agent`,
108
+ },
109
+ });
110
+ if (!intentId?.trim())
111
+ throw new Error('mandate intent creation returned no intentId');
112
+ const record = {
113
+ version: CARD_MANDATE_LEDGER_VERSION,
114
+ mandateId: intentId,
115
+ agentJkt: input.agentJkt,
116
+ tokenId: input.tokenId,
117
+ ceilingMinor: input.ceilingMinor,
118
+ spentMinor: 0,
119
+ reservations: [],
120
+ currencyCode,
121
+ merchantName: input.merchant.name,
122
+ merchantUrl: input.merchant.url,
123
+ merchantHost: host,
124
+ merchantCountryCode: input.merchant.countryCode.toUpperCase(),
125
+ approvalBaseUrl: deps.approvalBaseUrl,
126
+ ...(deps.mintToken ? { mintToken: deps.mintToken } : {}),
127
+ expiresAt: new Date(expiryMs).toISOString(),
128
+ maxDraws,
129
+ createdAt: now.toISOString(),
130
+ draws: [],
131
+ ...(input.crossMerchant ? { crossMerchant: true } : {}),
132
+ };
133
+ await deps.ledger.create(record, now);
134
+ return {
135
+ mandateId: record.mandateId,
136
+ ceilingMinor: record.ceilingMinor,
137
+ remainingMinor: remainingMinor(record),
138
+ currencyCode,
139
+ merchant: input.merchant,
140
+ expiresAt: record.expiresAt,
141
+ maxDraws,
142
+ };
143
+ }
144
+ const DRAW_REMEDY = 'the card-mandate draw did not complete — a ceiling-scoped assurance may not be honored ' +
145
+ 'for this sub-amount draw. The budget is untouched. If this was a transient network error ' +
146
+ '(gateway 5xx / try again), retry — the mandate stays active; a persistent decline disables ' +
147
+ 'the mandate and your next pay_merchant uses a fresh per-purchase tap';
148
+ /**
149
+ * Thrown ONLY for the post-reservation network/validation rejection class — the
150
+ * cryptogram fetch failed or returned a non-payable credential (the DRAW_REMEDY
151
+ * path). This is the sole draw failure that should DISABLE the mandate: it means
152
+ * the acquirer would not honor a ceiling-scoped assurance for a sub-amount draw.
153
+ *
154
+ * Pre-network failures — a fail-closed `reserve()` (concurrent over-budget race
155
+ * or expiry) or a `commit()` file-I/O error — throw a plain Error instead, so
156
+ * the caller (cli-engine) can rethrow them WITHOUT marking a HEALTHY mandate
157
+ * unhonored. Discriminating on this type is what keeps a transient race from
158
+ * permanently disabling a good mandate (michaelyang1 M1).
159
+ */
160
+ export class MandateDrawDeclinedError extends Error {
161
+ cause;
162
+ constructor(message, cause) {
163
+ super(message);
164
+ this.name = 'MandateDrawDeclinedError';
165
+ this.cause = cause;
166
+ }
167
+ }
168
+ /**
169
+ * Draw a cryptogram against an existing card mandate with NO fresh tap. The
170
+ * reservation is atomic and the budget is decremented ONLY after a payable
171
+ * cryptogram returns; any rejection releases the reservation so remaining is
172
+ * unchanged. Validates merchant + currency + amount against the mandate first.
173
+ */
174
+ export async function drawFromMandate(input, deps) {
175
+ assertPositiveInteger(input.amountMinor, 'draw amount');
176
+ const validate = deps.validate ?? validateCredential;
177
+ const now = (deps.now ?? (() => new Date()))();
178
+ const record = await deps.ledger.get(input.mandateId);
179
+ if (!record)
180
+ throw new Error(`no such mandate ${input.mandateId}`);
181
+ // The wire amount and the accounting amount MUST agree — a mismatch would
182
+ // draw one figure while reserving another. Fail before any reservation.
183
+ const wireMinor = decimalToMinor(input.transaction.transactionAmount);
184
+ if (wireMinor === null || wireMinor !== input.amountMinor) {
185
+ throw new Error(`draw amount ${input.amountMinor} disagrees with transaction amount ` +
186
+ `${JSON.stringify(input.transaction.transactionAmount)} (minor units)`);
187
+ }
188
+ // Currency must always match; merchant must match UNLESS this is a budget
189
+ // (crossMerchant) mandate the owner approved for eligible retail merchants. The network
190
+ // honors a ceiling-scoped cryptogram cross-merchant, so a budget mandate is
191
+ // deliberately not host-restricted — the ceiling + per-transaction limit still
192
+ // bound it.
193
+ const targetHost = merchantHost(input.transaction.merchantUrl);
194
+ if (!record.crossMerchant && targetHost !== record.merchantHost) {
195
+ throw new Error(`draw merchant ${targetHost} does not match mandate merchant ${record.merchantHost}`);
196
+ }
197
+ if (String(input.transaction.transactionCurrencyCode).toUpperCase() !==
198
+ record.currencyCode.toUpperCase()) {
199
+ throw new Error(`draw currency ${input.transaction.transactionCurrencyCode} does not match mandate ` +
200
+ `currency ${record.currencyCode}`);
201
+ }
202
+ // Atomic reserve — throws (fail-closed) if expired or over remaining budget.
203
+ const reservationId = await deps.ledger.reserve(input.mandateId, input.amountMinor, now);
204
+ let payment;
205
+ try {
206
+ payment = await deps.fetchCryptogram({
207
+ tokenId: record.tokenId,
208
+ intentId: record.mandateId,
209
+ transaction: input.transaction,
210
+ });
211
+ // A 2xx that is not actually a payable DAVV must NOT decrement the budget.
212
+ validate(payment);
213
+ }
214
+ catch (err) {
215
+ await deps.ledger.release(input.mandateId, reservationId, now);
216
+ // Typed so the caller disables the mandate ONLY for this post-reservation
217
+ // network/validation decline — never for a pre-network reserve()/commit()
218
+ // failure, which throws a plain Error above/below this try.
219
+ throw new MandateDrawDeclinedError(`${DRAW_REMEDY}: ${err.message}`, err);
220
+ }
221
+ const committed = await deps.ledger.commit(input.mandateId, reservationId, { intentId: record.mandateId }, now);
222
+ return {
223
+ payment,
224
+ intentId: record.mandateId,
225
+ remainingMinor: remainingMinor(committed),
226
+ };
227
+ }
@@ -0,0 +1,165 @@
1
+ export declare const CARD_MANDATE_LEDGER_VERSION: 1;
2
+ export type CardMandateReservation = {
3
+ reservationId: string;
4
+ amountMinor: number;
5
+ reservedAt: string;
6
+ };
7
+ export type CardMandateDraw = {
8
+ drawId: string;
9
+ reservationId: string;
10
+ amountMinor: number;
11
+ intentId: string;
12
+ status: 'committed' | 'released';
13
+ at: string;
14
+ };
15
+ export type CardMandateRecord = {
16
+ version: typeof CARD_MANDATE_LEDGER_VERSION;
17
+ /** == the VGS intentId the ceiling approval created. */
18
+ mandateId: string;
19
+ /** Exact runtime request key this budget was issued to. Absent on legacy rows. */
20
+ agentJkt?: string;
21
+ tokenId: string;
22
+ ceilingMinor: number;
23
+ /** Permanently committed (drawn) spend, integer minor units. */
24
+ spentMinor: number;
25
+ /** In-flight reservations (reserved but not yet committed/released). */
26
+ reservations: CardMandateReservation[];
27
+ currencyCode: string;
28
+ merchantName: string;
29
+ merchantUrl: string;
30
+ merchantHost: string;
31
+ merchantCountryCode: string;
32
+ /** verify-web origin the ceiling intent was minted against. */
33
+ approvalBaseUrl: string;
34
+ /**
35
+ * Scoped token released by the ceiling approval. It bootstraps the one intent
36
+ * + register ceremony only. Each cryptogram AND its outcome confirmation use
37
+ * the exact per-draw verdict instead. Owner-only (0600).
38
+ */
39
+ mintToken?: string;
40
+ expiresAt: string;
41
+ /** Network purchase-count cap disclosed at approval. Absent on legacy rows. */
42
+ maxDraws?: number;
43
+ createdAt: string;
44
+ draws: CardMandateDraw[];
45
+ /**
46
+ * Set when the network DECLINED a tap-free draw against this mandate (a
47
+ * ceiling-scoped assurance the acquirer would not honor for a sub-amount
48
+ * draw). Distinct from a reservation `status`: it disables the whole mandate.
49
+ * Once set, findCovering() SKIPS this mandate so the caller's next
50
+ * pay_merchant falls through to a fresh per-purchase tap instead of
51
+ * re-selecting the same failing mandate forever. ISO 8601.
52
+ */
53
+ unhonoredAt?: string;
54
+ /**
55
+ * Set when the delegated-draw register handshake FAILED at mandate-start (the
56
+ * server-side `card_mandate_spend` row was never created), so a later
57
+ * delegated (verdict-signed) draw would 404 `no_mandate`. Like `unhonoredAt`,
58
+ * findCovering() SKIPS a register-failed mandate so the next checkout falls
59
+ * through to a fresh per-purchase tap instead of surfacing a confusing
60
+ * `no_mandate`. Mandate-start requires delegated card authority, so every
61
+ * created record attempted registration. ISO 8601.
62
+ */
63
+ registerFailedAt?: string;
64
+ /**
65
+ * A cross-host retail budget, not scoped to one `merchantHost`. The local
66
+ * selector may attempt it at any host, while the provider/network still
67
+ * applies the approved Retail/5999 category plus amount/count/time controls.
68
+ * `crossMerchant` is retained as the version-1 persisted field name.
69
+ */
70
+ crossMerchant?: boolean;
71
+ };
72
+ export type CardMandateLedgerFile = {
73
+ version: typeof CARD_MANDATE_LEDGER_VERSION;
74
+ mandates: CardMandateRecord[];
75
+ };
76
+ export type CoverQuery = {
77
+ merchantHost: string;
78
+ currencyCode: string;
79
+ amountMinor: number;
80
+ /** Exact selected request key; omitted means legacy unbound mandates only. */
81
+ agentJkt?: string;
82
+ now?: Date;
83
+ };
84
+ /** Available headroom = ceiling - committed - reserved. Integer minor units. */
85
+ export declare function remainingMinor(record: CardMandateRecord): number;
86
+ /**
87
+ * The persisted card-mandate ledger. All mutating operations are serialized on
88
+ * an in-process promise chain so two concurrent draws cannot both observe the
89
+ * same remaining balance (the read-modify-write is atomic within the process).
90
+ */
91
+ export declare class MandateLedger {
92
+ private readonly path;
93
+ private chain;
94
+ constructor(path?: string);
95
+ /** Serialize a read-modify-write so concurrent draws can't race the file. */
96
+ private run;
97
+ private load;
98
+ private save;
99
+ /**
100
+ * Append a freshly-created mandate record. `now` drives the expired-mandate
101
+ * prune below; it defaults to the wall clock but is injectable so callers (and
102
+ * tests) can pin it — every other mutating method takes the same clock, and a
103
+ * real `new Date()` here would otherwise make the prune non-deterministic
104
+ * against fixtures dated relative to a fixed reference time.
105
+ */
106
+ create(record: CardMandateRecord, now?: Date): Promise<CardMandateRecord>;
107
+ /** Read a single mandate (no lock — a snapshot copy). */
108
+ get(mandateId: string): Promise<CardMandateRecord | null>;
109
+ /**
110
+ * First ACTIVE mandate (not expired) whose merchant + currency match and whose
111
+ * remaining headroom covers amountMinor. Used by pay_merchant to decide the
112
+ * tap-free draw path vs a fresh per-purchase tap.
113
+ */
114
+ findCovering(query: CoverQuery): Promise<CardMandateRecord | null>;
115
+ /**
116
+ * Mark a mandate as unhonored — the network declined a ceiling-scoped draw
117
+ * against it, so it must never be selected again. Atomic, owner-only write on
118
+ * the same serialized chain as every other mutation. Idempotent: a second
119
+ * call keeps the first timestamp. Throws only if the mandate is unknown.
120
+ */
121
+ markUnhonored(mandateId: string, now?: Date): Promise<CardMandateRecord>;
122
+ /**
123
+ * Mark a mandate as register-failed — the delegated-draw register handshake
124
+ * did not create the server row at mandate-start, so it must never be selected
125
+ * for a (delegated) draw. Atomic, owner-only write on the same serialized chain
126
+ * as every other mutation. Idempotent: a second call keeps the first timestamp.
127
+ * Throws only if the mandate is unknown.
128
+ */
129
+ markRegisterFailed(mandateId: string, now?: Date): Promise<CardMandateRecord>;
130
+ /**
131
+ * ONE SPENDING LIMIT: adopt the ceiling the SERVER actually approved.
132
+ *
133
+ * The requested ceiling is only a request. At register, auth clamps it to the
134
+ * owner's live card-grant cap (`min(requested, grant daily limit)`) and writes
135
+ * that. The local record used to keep the requested figure, so a runtime whose
136
+ * request exceeded the grant reported — and selected against — a budget the
137
+ * owner never approved. The draw still failed closed at auth's verdict, so it
138
+ * was never over-spend; it was the runtime lying about its own headroom and
139
+ * then hitting a decline it could not explain.
140
+ *
141
+ * LOWERS ONLY. A value at or above the current ceiling is ignored, not
142
+ * written: the server clamps downward, so a higher number means an unexpected
143
+ * response, and honouring it would let a client-observed value hand a runtime
144
+ * headroom no human approved. Cap authority stays server-side either way —
145
+ * this only stops the local copy from overstating it.
146
+ *
147
+ * Atomic and idempotent on the same serialized chain as every other mutation.
148
+ * Throws only if the mandate is unknown.
149
+ */
150
+ applyApprovedCeiling(mandateId: string, approvedCeilingMinor: number): Promise<CardMandateRecord>;
151
+ /**
152
+ * Atomically reserve headroom for a draw. Fail-closed: refuses when the
153
+ * mandate is unknown, expired, or the amount exceeds remaining headroom. The
154
+ * reservation counts against availability immediately, closing the window in
155
+ * which two concurrent draws both see the same remaining balance.
156
+ */
157
+ reserve(mandateId: string, amountMinor: number, now?: Date): Promise<string>;
158
+ /** Commit a reservation to permanent spend and record the payable draw. */
159
+ commit(mandateId: string, reservationId: string, meta: {
160
+ intentId: string;
161
+ }, now?: Date): Promise<CardMandateRecord>;
162
+ /** Release a reservation back to availability (draw failed / not payable). */
163
+ release(mandateId: string, reservationId: string, now?: Date): Promise<CardMandateRecord>;
164
+ }
165
+ export declare function defaultLedgerPath(): string;