@volter/twin-stripe 0.1.2 → 2.0.0

package/src/stripe-ui-conformance.ts

@@ -1,122 +1,85 @@
-// Stripe UI conformance — the declared UI surface inventory for a Stripe dashboard,
-// classified against THIS twin, and the read-only completeness check over it.
+// Stripe UI conformance — the declared surface inventory of Stripe's Dashboard, classified against THIS
+// twin, and the read-only completeness check over it.
 //
 // Honesty: `status` is the current truth, verified by the structural cross-check in
-// stripe-ui-conformance.test.ts (which builds the actual mirror bundle and asserts
-// each 'rendered' surface's helper/label/class is really present — downgrading to
-// 'modeled' otherwise). `rendered` = the mirror shows it today; `modeled` = the twin
-// has the data but the mirror doesn't render it (a UI gap to close); `unmodeled` =
-// real Stripe shows it but the twin doesn't model it (a twin-model gap to close).
+// stripe-ui-conformance.test.ts (which builds the actual Dashboard bundle and asserts each 'rendered'
+// surface's label/class is really present — downgrading to 'modeled' otherwise). `rendered` = the
+// Dashboard shows it today; `modeled` = the twin has the data but the Dashboard doesn't show it; `unmodeled`
+// = Stripe shows it but the twin doesn't model it.
 //
-// Classified against the actual mirror (client/stripe-mirror.tsx + the pure helpers in
-// stripe-mirror-ui.ts). The mirror has nineteen sections — customers, payment_intents,
-// setup_intents, subscriptions, invoices, invoiceitems, products, prices, charges,
-// refunds, payment_methods, disputes, payouts, balance_transactions, balance,
-// connected accounts, transfers, events — plus a Connect account panel (enablement
-// flags + outstanding requirements) and a generic detail panel that renders EVERY
-// scalar field (key/value grid), EVERY
-// nested object/array (flattened), status pills, amount/currency formatting, recurring
-// labels, product image <img> thumbnails, clickable cross-references (outgoing +
-// incoming), a prominent payment-decline banner (last_payment_error) and a synthesized
-// balance summary. So anything the twin stores on those collections is shown.
-import { checkUiCompleteness, type UiSurface, type UiCompletenessReport } from '@volter/twin-tooling';
+// Classified against the Dashboard (client/stripe-mirror.tsx, reading through client/dashboard-api.ts):
+// Home, Balances, Transactions > Payments and a payment's page, Customers and a customer's page, Product
+// catalog, Billing's Subscriptions (and a subscription's page) and Invoices (and an invoice's page),
+// Developers, Settings, and the resource lists under Connect, Payments, Reporting and More.
+import { checkUiCompleteness, type UiSurface, type UiCompletenessReport } from '@volter/world-tooling';
 
-/** What a real Stripe dashboard shows, classified vs the twin + its UI mirror. */
+/** What Stripe's Dashboard shows, classified vs the twin + its Dashboard. */
 export const STRIPE_UI_INVENTORY: UiSurface[] = [
-  // --- shell / cross-cutting surfaces the mirror provides everywhere ---
-  { key: 'sectionNav', label: 'Left-nav sections (Customers/Payments/Subs/Invoices/Products/Prices) with counts', status: 'rendered' },
-  { key: 'listDetailSplit', label: 'List + detail split per section', status: 'rendered' },
-  { key: 'sectionFilter', label: 'In-section text filter / search', status: 'rendered' },
-  { key: 'statusPill', label: 'Status pill with semantic tone (ok/warn/bad)', status: 'rendered' },
-  { key: 'amountFormatting', label: 'Currency-formatted amounts (zero-decimal aware)', status: 'rendered' },
-  { key: 'nestedFields', label: 'Nested object/array fields flattened (no "[object Object]")', status: 'rendered' },
-  { key: 'crossLinksOutgoing', label: 'Outgoing cross-links (this row → referenced objects)', status: 'rendered' },
-  { key: 'crossLinksIncoming', label: 'Incoming cross-links (objects referencing this row)', status: 'rendered' },
-  { key: 'metadata', label: 'Object metadata key/values', status: 'rendered' },
+  // --- shell ---
+  { key: 'navigation', label: 'Left navigation (Home, Balances, Transactions, Customers, Product catalog, Billing, Developers)', status: 'rendered' },
+  { key: 'testModeBand', label: 'Test-mode band', status: 'rendered' },
+  { key: 'search', label: 'Search across customers, payments, subscriptions, invoices, products', status: 'rendered' },
+  { key: 'statusPill', label: "Status pills in Stripe's words (Succeeded, Refunded, Failed, Active, Trialing, Paid, …)", status: 'rendered' },
+  { key: 'amountFormatting', label: 'Currency-formatted amounts with the currency code', status: 'rendered' },
 
-  // --- customers ---
-  { key: 'customerName', label: 'Customer name', status: 'rendered' },
-  { key: 'customerEmail', label: 'Customer email', status: 'rendered' },
-  // Customer credit balance is now modeled (customer.balance + a balance-transaction ledger)
-  // and rendered as its own "Customer Balance" mirror section (amount + running ending_balance).
-  { key: 'customerBalance', label: 'Customer account balance (credit-balance ledger)', status: 'rendered' },
-  // Customer tax IDs (eu_vat / us_ein / …) are a modeled customer sub-resource with their
-  // own "Customer Tax IDs" mirror section (value + type + owning customer cross-link).
-  { key: 'customerTaxIds', label: 'Customer tax IDs (value / type)', status: 'rendered' },
+  // --- Home and Balances ---
+  { key: 'homeToday', label: "Home: today's gross volume, balance and payouts", status: 'rendered' },
+  { key: 'homeOverview', label: 'Home: overview metrics (gross/net volume, successful and failed payments, customers, subscribers)', status: 'rendered' },
+  { key: 'balanceSummary', label: 'Balances: incoming and available per currency', status: 'rendered' },
+  { key: 'balanceTransactions', label: 'Balances: recent activity (balance transactions) and payouts', status: 'rendered' },
 
-  // --- payments (payment_intents) ---
-  { key: 'paymentList', label: 'Payments list (amount + id)', status: 'rendered' },
-  { key: 'paymentStatus', label: 'Payment status (succeeded/requires_*/…)', status: 'rendered' },
-  { key: 'paymentAmount', label: 'Payment amount (formatted)', status: 'rendered' },
-  { key: 'paymentCustomerLink', label: 'Payment → customer cross-link', status: 'rendered' },
-  // test-card decline state: last_payment_error rendered as a prominent error banner.
-  { key: 'paymentDecline', label: 'Payment decline reason (last_payment_error banner)', status: 'rendered' },
-
-  // --- setup_intents (off-session card save) ---
-  { key: 'setupIntents', label: 'Setup intents list + status (requires_confirmation/succeeded)', status: 'rendered' },
-
-  // --- subscriptions ---
-  { key: 'subscriptionStatus', label: 'Subscription status (active/trialing/past_due/…)', status: 'rendered' },
-  { key: 'subscriptionCustomerLink', label: 'Subscription → customer cross-link', status: 'rendered' },
-  // items + period are nested objects the twin stores and the flattener renders.
-  { key: 'subscriptionItems', label: 'Subscription line items (nested)', status: 'rendered' },
-  { key: 'subscriptionPeriod', label: 'Billing-cycle / period fields', status: 'rendered' },
-
-  // --- invoices ---
-  { key: 'invoiceStatus', label: 'Invoice status (draft/open/paid/void/…)', status: 'rendered' },
-  { key: 'invoiceTotal', label: 'Invoice total / amount_due (formatted)', status: 'rendered' },
-  { key: 'invoiceLines', label: 'Invoice line items (nested list)', status: 'rendered' },
-  { key: 'invoiceCustomerLink', label: 'Invoice → customer cross-link', status: 'rendered' },
-  // invoiceitems are a full twin resource with their own list endpoint + nav section.
-  { key: 'invoiceItems', label: 'Invoice items list (pending line items)', status: 'rendered' },
-  // credit notes are a full twin resource (create/preview/void/list) with their own nav
-  // section + list/detail; rows show the credited amount + status, with an invoice cross-link.
-  { key: 'creditNotes', label: 'Credit notes list (credited amount + status)', status: 'rendered' },
-  { key: 'creditNoteLines', label: 'Credit note line items (nested)', status: 'rendered' },
-
-  // --- products ---
-  { key: 'productName', label: 'Product name', status: 'rendered' },
-  // images is an array of URLs; the detail view now renders them as <img> thumbnails.
-  { key: 'productImageThumbs', label: 'Product image thumbnails (rendered as <img>)', status: 'rendered' },
+  // --- Payments ---
+  { key: 'paymentList', label: 'Payments list: amount + currency, status, payment method, description, customer, date', status: 'rendered' },
+  { key: 'paymentFilters', label: 'Payments status tabs with counts, and filter chips', status: 'rendered' },
+  { key: 'paymentRefundedDate', label: 'Payments list: refunded date and decline reason', status: 'rendered' },
+  { key: 'paymentExport', label: 'Payments export', status: 'rendered' },
+  { key: 'paymentTimeline', label: "A payment's timeline from its events", status: 'rendered' },
+  { key: 'paymentBreakdown', label: "A payment's breakdown (amount, refunded, net)", status: 'rendered' },
+  { key: 'paymentFees', label: "A payment's Stripe fees (balance transaction fee details)", status: 'unmodeled' },
+  { key: 'paymentRefunds', label: "A payment's refunds", status: 'rendered' },
+  { key: 'paymentMethodDetails', label: "A payment's card: last four, expiry, type, origin, CVC check", status: 'rendered' },
+  { key: 'paymentDecline', label: 'A declined payment states its error and decline code', status: 'rendered' },
+  { key: 'refundDialog', label: 'Refund a payment in full or in part, with a reason', status: 'rendered' },
+  { key: 'disputes', label: 'Disputes', status: 'rendered' },
 
-  // --- prices ---
-  { key: 'priceUnitAmount', label: 'Price unit amount (formatted)', status: 'rendered' },
-  { key: 'priceRecurring', label: 'Price recurring interval ("every month")', status: 'rendered' },
-  { key: 'priceProductLink', label: 'Price → product cross-link', status: 'rendered' },
+  // --- Customers ---
+  { key: 'customerList', label: 'Customers list: name, email, default payment method, created, total spend, payments, refunds', status: 'rendered' },
+  { key: 'createCustomer', label: 'Create customer', status: 'rendered' },
+  { key: 'customerDetails', label: "A customer's details (ID, since, email, description, billing details)", status: 'rendered' },
+  { key: 'customerSubscriptions', label: "A customer's subscriptions", status: 'rendered' },
+  { key: 'customerPayments', label: "A customer's payments", status: 'rendered' },
+  { key: 'customerPaymentMethods', label: "A customer's saved payment methods, default marked", status: 'rendered' },
+  { key: 'customerInvoices', label: "A customer's invoices", status: 'rendered' },
+  { key: 'customerEvents', label: "A customer's events", status: 'rendered' },
 
-  // --- collections the twin models, now each with its own nav section + list/detail ---
-  // charges, refunds and payment_methods are full twin resources with list endpoints;
-  // stripe-mirror.tsx now has a nav section + list/detail for each.
-  { key: 'charges', label: 'Charges list + status', status: 'rendered' },
-  { key: 'refunds', label: 'Refunds list (refund objects)', status: 'rendered' },
-  { key: 'paymentMethods', label: 'Saved payment methods (cards)', status: 'rendered' },
+  // --- Billing ---
+  { key: 'subscriptionList', label: 'Subscriptions list: customer, status, billing, product, amount, created', status: 'rendered' },
+  { key: 'subscriptionDetails', label: "A subscription's details: customer, period, trial, billing method, payment method", status: 'rendered' },
+  { key: 'subscriptionPricing', label: "A subscription's pricing items", status: 'rendered' },
+  { key: 'cancelSubscription', label: 'Cancel a subscription now or at period end', status: 'rendered' },
+  { key: 'invoiceList', label: 'Invoices list: amount, status, number, customer, due, created', status: 'rendered' },
+  { key: 'invoiceDetail', label: "An invoice's summary lines and totals", status: 'rendered' },
+  { key: 'quotes', label: 'Quotes', status: 'rendered' },
 
-  // disputes/payouts/balance_transactions/events are full twin resources with list +
-  // CRUD/action endpoints (stripe-twin.ts) and vendor-faithful schemas; the mirror now
-  // renders a nav section + list/detail for each.
-  { key: 'disputes', label: 'Disputes', status: 'rendered' },
-  { key: 'payouts', label: 'Payouts', status: 'rendered' },
-  { key: 'balanceTransactions', label: 'Balance transactions ledger', status: 'rendered' },
-  // the synthesized account balance summary (GET /v1/balance) has its own nav section
-  // with available/pending buckets per currency.
-  { key: 'balanceSummary', label: 'Account balance summary (available/pending)', status: 'rendered' },
-  { key: 'eventsLog', label: 'Events / activity log', status: 'rendered' },
+  // --- Product catalog ---
+  { key: 'productCatalog', label: 'Product catalog: name, pricing, created, updated', status: 'rendered' },
+  { key: 'createProduct', label: 'Create product', status: 'rendered' },
+  { key: 'coupons', label: 'Coupons', status: 'rendered' },
 
-  // --- Connect (connected accounts + transfers) — full twin resources with their own
-  // nav sections + list/detail; the account detail surfaces the enablement flags +
-  // outstanding requirements, transfers cross-link to their destination account. ---
-  { key: 'connectAccounts', label: 'Connect / connected accounts list + detail', status: 'rendered' },
-  { key: 'connectAccountFlags', label: 'Connected-account enablement flags (charges/payouts/details_submitted)', status: 'rendered' },
-  { key: 'connectAccountRequirements', label: 'Connected-account outstanding onboarding requirements (currently_due)', status: 'rendered' },
-  { key: 'connectTransfers', label: 'Transfers list (platform → connected account)', status: 'rendered' },
-  { key: 'connectTransferDestinationLink', label: 'Transfer → destination connected-account cross-link', status: 'rendered' },
+  // --- Developers and Settings ---
+  { key: 'apiKeys', label: 'API keys', status: 'rendered' },
+  { key: 'webhooks', label: 'Webhook endpoints', status: 'rendered' },
+  { key: 'eventsLog', label: 'Events', status: 'rendered' },
+  { key: 'payoutSchedule', label: 'Settings: payout schedule', status: 'rendered' },
 
-  // --- Stripe Tax (tax rates + calculations) — full twin resources with their own nav
-  // sections + list/detail; rates show display_name/percentage/inclusive, calculations
-  // show amount_total + tax + their priced line_items (nested). ---
-  { key: 'taxRates', label: 'Tax rates list (display_name / percentage / inclusive)', status: 'rendered' },
-  { key: 'taxCalculations', label: 'Tax calculations list (amount_total + tax amount)', status: 'rendered' },
-  { key: 'taxCalculationLineItems', label: 'Tax calculation line items (nested, per-item tax)', status: 'rendered' },
+  // --- under More ---
+  { key: 'connectAccounts', label: 'Connect: connected accounts, readiness flags and requirements due', status: 'rendered' },
+  { key: 'connectTransfers', label: 'Connect: transfers', status: 'rendered' },
+  { key: 'radar', label: 'Radar: reviews, lists, rules', status: 'rendered' },
+  { key: 'terminal', label: 'Terminal: readers, locations', status: 'rendered' },
+  { key: 'issuing', label: 'Issuing: cards, cardholders', status: 'rendered' },
+  { key: 'taxRates', label: 'Tax: tax rates', status: 'rendered' },
+  { key: 'reports', label: 'Reporting: report runs', status: 'rendered' },
 ];
 
 /** Read-only completeness check over the declared Stripe UI inventory. */