Skip to content

feature-account 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
AccountContextThe context AccountProvider fills.
@evolve-storefront/feature-account/context
useAccountContextRead the injected auth/session/mode context.
@evolve-storefront/feature-account/context
useHasPermissionsTrue when the buyer holds every listed permission (business menu gating).
@evolve-storefront/feature-account/context
accountDefaultsWhat the context holds without an AccountProvider: a signed-out consumer with no capabilities.
@evolve-storefront/feature-account/context
AccountCapabilitiesProject-selectable capabilities.
@evolve-storefront/feature-account/context
AccountContextValueInjected auth/session/mode seam for the account feature.
@evolve-storefront/feature-account/context
AccountModeConsumer (B2C) vs business (B2B) — configuration, not a fork.
@evolve-storefront/feature-account/context
GraphQL documents10
CustomerAddressCreateAdds an address to the customer's address book.
@evolve-storefront/feature-account/queries
CustomerAddressDeleteRemoves one address from the customer's address book.
@evolve-storefront/feature-account/queries
CustomerAddressUpdateReplaces one address in the customer's address book.
@evolve-storefront/feature-account/queries
CustomerDefaultAddressUpdateSet the default shipping and/or billing address.
@evolve-storefront/feature-account/queries
CustomerDeleteDeletes the customer's account.
@evolve-storefront/feature-account/queries
CustomerEmailUpdateChanges the customer's email address.
@evolve-storefront/feature-account/queries
CustomerPasswordUpdateChanges the customer's password.
@evolve-storefront/feature-account/queries
CustomerPersonalDetailsUpdateDecoupled personal-details update — touches no address.
@evolve-storefront/feature-account/queries
GetCustomerThe signed-in customer: personal details and default addresses.
@evolve-storefront/feature-account/queries
GetCustomerAddressesOne page of the customer's address book, optionally narrowed by a search term.
@evolve-storefront/feature-account/queries
Data and cache helpers5
invalidateCustomerInvalidate the customer cache after a profile/address/credential change.
@evolve-storefront/feature-account
localizedCountriesLocalized country options: preferred first in its own order, then the rest sorted with Intl.Collator, because alphabetical order differs per locale.
@evolve-storefront/feature-account
setCustomerCacheMerge a fresh customer payload into the cache (post-mutation).
@evolve-storefront/feature-account
accountKeysreact-query key factory for the account caches.
@evolve-storefront/feature-account
ISO_COUNTRY_CODESISO-3166-1 alpha-2 region codes.
@evolve-storefront/feature-account
Schemas7
createAddressFormSchemaBuild the address schema for a config + country.
@evolve-storefront/feature-account/schemas
withStrictPhoneWrap any address schema with strict phone validation.
@evolve-storefront/feature-account/schemas
AddressFormSchemaThe default-config schema — the public, statically-typed instance consumers already depend on.
@evolve-storefront/feature-account/schemas
ChangeEmailFormSchemaChange-email form schema: a new email plus the current password for re-authentication.
@evolve-storefront/feature-account/schemas
ChangePasswordFormSchemaChange-password form schema: the current password plus a new password entered twice.
@evolve-storefront/feature-account/schemas
ProfileFormSchemaPersonal-details form schema — one source of truth, reused by the backend.
@evolve-storefront/feature-account/schemas
StrictAddressFormSchemaStrict phone variant of the default AddressFormSchema, for the server.
@evolve-storefront/feature-account/schemas
Types30
AddressA saved address (schema Address).
@evolve-storefront/feature-account
AddressInputWrite shape for an address (schema AddressInput).
@evolve-storefront/feature-account
AddressResultA page of the customer's address book (schema AddressResult).
@evolve-storefront/feature-account
CountryCodeA 2-letter ISO-3166-1 alpha-2 region code.
@evolve-storefront/feature-account
CustomerThe signed-in customer (schema Customer).
@evolve-storefront/feature-account
CustomerDeleteResultThe customerDelete result ({ success, customerErrors }).
@evolve-storefront/feature-account
CustomerMutationErrorTyped-error payload shape shared by the customer mutations (ValidationError).
@evolve-storefront/feature-account
CustomerMutationResultA { customer, customerErrors } mutation result (schema pattern).
@evolve-storefront/feature-account
NotificationPreferencesMarketing / notification opt-ins (schema NotificationPreferences).
@evolve-storefront/feature-account
ProfileInputThe editable personal-details subset (schema CustomerPersonalDetailsInput).
@evolve-storefront/feature-account
SalutationAddress salutation (schema Salutation enum).
@evolve-storefront/feature-account
AddressFormInput
@evolve-storefront/feature-account/schemas
ChangeEmailFormInput
@evolve-storefront/feature-account/schemas
ChangePasswordFormInput
@evolve-storefront/feature-account/schemas
ProfileFormInput
@evolve-storefront/feature-account/schemas
StrictAddressFormInput
@evolve-storefront/feature-account/schemas
AddressBookDescriptorWhat a surface that lists the book takes, such as a checkout section's addressBook.
@evolve-storefront/feature-account/hooks
UseAddressBookResult
@evolve-storefront/feature-account/hooks
UseAddressFormResult
@evolve-storefront/feature-account/hooks
UseChangeEmailFormResult
@evolve-storefront/feature-account/hooks
UseChangePasswordFormResult
@evolve-storefront/feature-account/hooks
UseProfileFormResult
@evolve-storefront/feature-account/hooks
AccountNavGroupA heading in the account menu that items join through their group.
@evolve-storefront/feature-account/account-shell
AccountNavItem
@evolve-storefront/feature-account/account-shell
AccountQuickLinkOne account page as a card: the shell's nav item, with an optional line and icon.
@evolve-storefront/feature-account/account-quick-links
AccountQuickLinkRendererRenders one card, replacing the shipped one; the list still owns its position.
@evolve-storefront/feature-account/account-quick-links
AddressBookItemRendererRenders one saved address.
@evolve-storefront/feature-account/address-book
ProfileFormBindingThe props a save hook supplies — spread onto <ProfileForm>.
@evolve-storefront/feature-account/profile-form
ChangeEmailFormBindingThe props a save hook supplies — spread onto <ChangeEmailForm>.
@evolve-storefront/feature-account/change-email-form
ChangePasswordFormBindingThe props a save hook supplies — spread onto <ChangePasswordForm>.
@evolve-storefront/feature-account/change-password-form

Not listed: 17 props and options types. They appear as the tables on the pages of what they type.