@capxul/cli 4.20.0-beta.20 → 4.20.0-beta.21

package/README.md

@@ -204,8 +204,11 @@ require `--confirm` before session restoration. A lost write reply gives an
 exact readback command in the same scope and session. It never repeats the
 write. These commands start no signer and move no funds.
 
-Issue accepts an Invoice request JSON object from `--input FILE` or `--input -`.
-It saves the issued Invoice PDF in the common document directory by default.
+Issue accepts a basic payment request or an Invoice request JSON object from
+`--input FILE` or `--input -`. Both require `payer` and an exact positive
+`amount`. A basic request requires an explicit `reference` and accepts an
+optional private `memo`. An Invoice request also supplies `invoice`.
+Issue saves available document PDFs in the common directory by default.
 Human and JSON output include `checkoutUrl` for an Invoice instruction with a link token.
 Memo requests do not receive an Invoice checkout URL.
 The PDF includes the checkout link from the authorized backend render context.
@@ -234,6 +237,17 @@ output; use the printed document render command.
 }
 ```
 
+For a basic request, omit `invoice`:
+
+```json
+{
+  "payer": { "kind": "email", "email": "bob@example.com" },
+  "amount": { "asset": "<admitted asset ID>", "value": "9" },
+  "reference": "SESSION-001",
+  "memo": "Counselling session"
+}
+```
+
 Supply your Invoice number. The request reference defaults to that number;
 optional `reference` changes the request reference only. `dueAt` uses epoch
 milliseconds, as the shared Invoice document and frontend do. Set it to zero
@@ -1037,5 +1051,67 @@ positive whole numbers.
 Creation requires an explicit replay key. Keep the key and identical terms when
 recovering an uncertain result. Read the offer list before another write. Revision
 and deactivation require the revision you observed. A conflict requires a fresh
-read. The CLI does not retry a write automatically. Checkout links are not emitted
-until the checkout route works.
+read. The CLI does not retry a write automatically. Successful offer results
+include `checkoutUrl`. Share that URL for another purchase of the same offer.
+An offer link is not a saved purchase or proof of payment.
+
+The checkout page reads the current offer before the payer continues. A quantity
+in the URL is a hint. The backend checks its bounds and freezes the selected
+revision, quantity, price, asset, network, and recipient for that purchase.
+Changing the URL cannot change a saved purchase. Refresh retains its checkout
+reference. Separate purchasers receive separate checkout and settlement IDs.
+
+## Invoice and document flow
+
+Alice issues an Invoice to Bob with `request issue`. For an Organization issuer,
+Alice uses `org request issue --org ORGANIZATION_ID`. Issuance saves Alice's PDF
+by default and returns the request ID, document references, and checkout URL.
+Bob runs `inbox list`, then `inbox get --request-id REQUEST_ID`. An Organization
+payer uses the equivalent `org inbox` commands with its explicit Organization.
+
+Bob's Inbox contains the request and document references. It does not receive a
+local PDF automatically. Bob uses the printed `document render` command to save
+his copy. Both participants read the same verified document. Their files can
+have different local paths. `status` shows available request and document counts;
+it does not download documents.
+
+A direct Payment uses the existing Payment and Activity commands. Alice inspects
+her outgoing records. Bob inspects his incoming records after the backend observes
+them. Available document references can then be rendered by an authorized
+participant. Issuance, signing, submission, and settlement are separate states.
+A PDF file or checkout link does not prove that funds moved.
+
+Cancellation removes the request from the received Inbox list. Because `inbox get`
+reads that list, it cannot find the cancelled ID. Existing participant document
+access remains available through the saved document and content hashes. Keep
+those references when retaining a cancelled Invoice.
+
+The shared document directory is `documents` next to the CLI settings directory.
+`CAPXUL_CLI_HOME` selects a separate CLI settings directory. `--output-dir` changes
+the document output location for supported document and payment commands. Each
+render preserves previous files. A failed PDF render does not repeat issuance or
+payment. Retry `document render` with the existing document references.
+
+## Checkout links
+
+An Invoice URL has the form `/checkout/invoices/LINK_TOKEN`. An offer URL has the
+form `/checkout/offers/OFFER_ID`. Use the complete `checkoutUrl` returned by the
+CLI. Do not build a payment by sending funds directly to the printed Safe.
+
+A valid Invoice link holder can fund its fixed obligation. The named debtor and
+actual sender remain separate. Public checkout shows the approved payment
+summary. It does not expose private billing details or original document bytes.
+Only authorized participants can open the private Invoice document.
+
+The checkout page offers registered Account or Organization funding and supported
+external wallet funding. Registered funding uses the selected actor's authority.
+External funding requires the correct network, balance, gas, and any exact token
+approval. Payment goes through the Payments contract with the validated snapshot.
+Inspect the resulting state and receipt before reporting payment complete.
+
+CLI `inbox pay` retains its existing CLI signing flow. It does not depend on the
+hosted checkout page. A rejected signature or uncertain reply is not permission
+to send another Payment. Use the printed readback and recovery instructions.
+
+Checkout links do not create recurring billing, automatic debits, booking,
+refunds, or QR codes.

package/dist/browser/signer.js

@@ -21347,6 +21347,7 @@
 	});
 	/** Link holders receive payment terms, not the private Invoice document. */
 	const InvoiceCheckoutSummarySchema = Struct({
+		documentKind: optional(Literals(["memo", "invoice"])),
 		linkToken: text$1(128),
 		issuerLabel: text$1(256),
 		dueAt: InvoiceDraftSchema.fields.dueAt,
@@ -21368,7 +21369,7 @@
 			"unavailable"
 		])
 	});
-	Struct({
+	const InvoiceCheckoutPreparationSchema = Struct({
 		invoice: InvoiceCheckoutSummarySchema,
 		sourceWallet: AddressSchema$1,
 		allowance: OfferCheckoutPreparationSchema.fields.allowance,
@@ -21408,6 +21409,44 @@
 		...registeredCheckoutExecutionFields,
 		invoice: InvoiceCheckoutSummarySchema
 	});
+	/** Generic request checkout uses the same fixed obligation and receipt contract. */
+	const RequestCheckoutSummarySchema = Struct({
+		...InvoiceCheckoutSummarySchema.fields,
+		documentKind: Literals(["memo", "invoice"])
+	});
+	Struct({
+		request: RequestCheckoutSummarySchema,
+		sourceWallet: InvoiceCheckoutPreparationSchema.fields.sourceWallet,
+		allowance: InvoiceCheckoutPreparationSchema.fields.allowance,
+		approval: InvoiceCheckoutPreparationSchema.fields.approval,
+		payment: InvoiceCheckoutPreparationSchema.fields.payment
+	});
+	const RequestCheckoutStateSchema = Struct({
+		request: RequestCheckoutSummarySchema,
+		verification: InvoiceCheckoutStateSchema.fields.verification,
+		receipt: InvoiceCheckoutStateSchema.fields.receipt,
+		latePayment: InvoiceCheckoutStateSchema.fields.latePayment
+	});
+	Union([
+		Struct({
+			status: Literal("verified"),
+			receipt: CheckoutReceiptSchema,
+			state: RequestCheckoutStateSchema
+		}),
+		Struct({
+			status: Literals(["pending", "provider_failure"]),
+			state: RequestCheckoutStateSchema
+		}),
+		Struct({
+			status: Literal("mismatch"),
+			code: String$1,
+			state: RequestCheckoutStateSchema
+		})
+	]);
+	Struct({
+		...registeredCheckoutExecutionFields,
+		request: RequestCheckoutSummarySchema
+	});
 	//#endregion
 	//#region ../../packages/wire/src/bootstrap.ts
 	const PUBLIC_POSTHOG_PROJECT_TOKEN = /^phc_[A-Za-z0-9_-]{1,191}$/u;
@@ -21513,6 +21552,13 @@
 			state: "financialOps/offerCheckoutSettlement:state",
 			reconcile: "financialOps/offerCheckoutSettlement:reconcile"
 		},
+		"financialOps/requestCheckouts": {
+			summary: "financialOps/requestCheckouts:summary",
+			prepare: "financialOps/requestCheckouts:prepare",
+			state: "financialOps/requestCheckouts:state",
+			reconcile: "financialOps/requestCheckouts:reconcile",
+			prepareRegistered: "financialOps/requestCheckouts:prepareRegistered"
+		},
 		"financialOps/invoiceCheckouts": {
 			summary: "financialOps/invoiceCheckouts:summary",
 			prepare: "financialOps/invoiceCheckouts:prepare",
@@ -22798,6 +22844,11 @@ body:has(> .capxul-doc){margin:0}
 			deactivate: "offers.deactivate"
 		},
 		checkouts: {
+			request: "checkouts.request",
+			prepareRequest: "checkouts.prepareRequest",
+			requestState: "checkouts.requestState",
+			reconcileRequest: "checkouts.reconcileRequest",
+			prepareRequestRegistered: "checkouts.prepareRequestRegistered",
 			invoice: "checkouts.invoice",
 			prepareInvoice: "checkouts.prepareInvoice",
 			invoiceState: "checkouts.invoiceState",
@@ -85343,8 +85394,9 @@ ${SUCCESS}
 	//#region ../../packages/sdk/src/contract/checkouts.ts
 	const fns = CAPXUL_FUNCTIONS["financialOps/offerCheckouts"];
 	const settlement = CAPXUL_FUNCTIONS["financialOps/offerCheckoutSettlement"];
+	const requests = CAPXUL_FUNCTIONS["financialOps/requestCheckouts"];
 	const invoices = CAPXUL_FUNCTIONS["financialOps/invoiceCheckouts"];
-	invoices.summary, invoices.prepare, invoices.state, invoices.reconcile, CAPXUL_FUNCTIONS["moneyExecution/paymentCommandActions"].prepareInvoiceCheckoutExecution, CAPXUL_FUNCTIONS["moneyExecution/paymentCommandActions"].prepareOfferCheckoutExecution, settlement.state, settlement.reconcile, fns.prepare, fns.offer, fns.create, fns.get;
+	requests.summary, requests.prepare, requests.state, requests.reconcile, requests.prepareRegistered, invoices.summary, invoices.prepare, invoices.state, invoices.reconcile, CAPXUL_FUNCTIONS["moneyExecution/paymentCommandActions"].prepareInvoiceCheckoutExecution, CAPXUL_FUNCTIONS["moneyExecution/paymentCommandActions"].prepareOfferCheckoutExecution, settlement.state, settlement.reconcile, fns.prepare, fns.offer, fns.create, fns.get;
 	//#endregion
 	//#region ../../packages/sdk/src/surface/accounts-deps.ts
 	var AccountsDepsTag = class extends Service()("@capxul/sdk/AccountsDeps") {};