feature-invoice advanced
Everything else the package exports, for when you go beyond its components and hooks, such as your own queries or cache updates. Most projects never need these.
Contexts7
InvoiceContext | The context InvoiceProvider fills.@evolve-storefront/feature-invoice/context |
useCanViewInvoices | Whether invoices may be shown/queried at all. @evolve-storefront/feature-invoice/context |
useInvoiceContext | Read the injected auth/session/mode context. @evolve-storefront/feature-invoice/context |
useInvoiceScope | Derive the read scope from the injected mode. @evolve-storefront/feature-invoice/context |
invoiceDefaults | What the context holds without an InvoiceProvider: a signed-out consumer.@evolve-storefront/feature-invoice/context |
InvoiceContextValue | Injected auth/session/mode seam for the invoice feature. @evolve-storefront/feature-invoice/context |
InvoiceMode | Consumer (own invoices) vs business (company-scoped) — config, not a fork. @evolve-storefront/feature-invoice/context |
GraphQL documents6
GetBusinessInvoice | One of a business unit's invoices, by id. @evolve-storefront/feature-invoice/queries |
GetBusinessInvoiceCredit | The business unit's credit, for CreditSummary; the backend works out available.@evolve-storefront/feature-invoice/queries |
GetBusinessInvoices | A business unit's invoices, paged, with search, status and date filters. @evolve-storefront/feature-invoice/queries |
GetCustomerInvoice | A personal buyer's single invoice. @evolve-storefront/feature-invoice/queries |
GetCustomerInvoices | The signed-in customer's invoices, paged, with search, status and date filters. @evolve-storefront/feature-invoice/queries |
InvoicePay | Start a payment against an invoice. @evolve-storefront/feature-invoice/queries |
Data and cache helpers2
invalidateInvoices | Invalidate every list cache for a scope (all pages / filters). @evolve-storefront/feature-invoice |
invoiceKeys | react-query key factory for the invoice list + detail caches. @evolve-storefront/feature-invoice |
Errors3
InvoicePaymentError | The gateway refused to start the payment. @evolve-storefront/feature-invoice/hooks |
InvoicePaymentNotConfiguredError | InvoiceProvider was given no returnUrls.@evolve-storefront/feature-invoice/hooks |
InvoicePaymentRedirectMissingError | The payment was created and the gateway named nowhere to send the buyer. @evolve-storefront/feature-invoice/hooks |
Other functions and constants3
countsByStatus | [{ status, count }] as a record by status; null stays null.@evolve-storefront/feature-invoice/queries |
readPayInvoiceResponse | Turn paymentCreate's response into a destination or a throw.@evolve-storefront/feature-invoice/hooks |
OUTSTANDING_INVOICE_STATUSES | The states an invoice still owes money in: what RecentInvoices shows.@evolve-storefront/feature-invoice/recent-invoices |
Types15
Invoice | Full invoice for the detail view. @evolve-storefront/feature-invoice |
InvoiceClientDevice | Which client is asking, since the offered methods differ by it (schema ClientDeviceType).@evolve-storefront/feature-invoice |
InvoiceCredit | A business unit's credit: the limit, what is in use, and what is left. @evolve-storefront/feature-invoice |
InvoicePaymentMethod | A payment method offered for an invoice. @evolve-storefront/feature-invoice |
InvoicePaymentMethodInput | The payment method to charge with, chosen from the ones the storefront offers. @evolve-storefront/feature-invoice |
InvoiceResult | Paginated invoice list. @evolve-storefront/feature-invoice |
InvoiceReturnUrls | Where the payment provider returns the buyer after paying an invoice. @evolve-storefront/feature-invoice |
InvoiceScope | Read scope — consumer (own invoices) vs business (company-scoped). @evolve-storefront/feature-invoice |
InvoiceStatus | Invoice lifecycle status — the InvoiceStatusType enum, verbatim.@evolve-storefront/feature-invoice |
InvoiceStatusCount | The number of invoices in one status (schema InvoiceStatusCount).@evolve-storefront/feature-invoice |
InvoiceSummary | Summary shape for the invoice list. @evolve-storefront/feature-invoice |
Money | Money (target Money): minor units + ISO currency.@evolve-storefront/feature-invoice |
PayInvoiceResult | @evolve-storefront/feature-invoice/hooks |
PayInvoiceVariables | @evolve-storefront/feature-invoice/hooks |
InvoiceListFilterNames | The form field names, so they line up with what the page reads from its search params. @evolve-storefront/feature-invoice/invoice-list |
Not listed: 16 props and options types. They appear as the tables on the pages of what they type.