Skip to content

feature-auth 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.

Contexts3
AuthContextThe context AuthProvider fills.
@evolve-storefront/feature-auth/context
useAuthContextRead the injected session seam.
@evolve-storefront/feature-auth/context
AuthContextValueInjected session seam for the auth feature.
@evolve-storefront/feature-auth/context
Data and cache helpers4
loginHrefA link to the login page that brings the visitor back to returnTo afterwards.
@evolve-storefront/feature-auth
returnToPathWhere to go after signing in: the query's returnTo when safe, else fallback.
@evolve-storefront/feature-auth
scorePasswordScore a password 0–4 for guidance only — never enforcement (AUTH §4).
@evolve-storefront/feature-auth
RETURN_TO_PARAMThe query parameter a login link carries the page to come back to in.
@evolve-storefront/feature-auth
Schemas4
LoginFormSchemaLogin form schema — one source of truth, client + server.
@evolve-storefront/feature-auth/schemas
PasswordResetFormSchemaSet-new-password schema.
@evolve-storefront/feature-auth/schemas
PasswordResetRequestFormSchemaPassword-reset request schema — email only.
@evolve-storefront/feature-auth/schemas
RegisterFormSchemaRegister form schema — client + server.
@evolve-storefront/feature-auth/schemas
Other functions and constants6
CustomerCreateRegisters a new customer account.
@evolve-storefront/feature-auth/documents
CustomerExistsWhether an account exists for an email address.
@evolve-storefront/feature-auth/documents
CustomerLoginSigns a customer in with email and password.
@evolve-storefront/feature-auth/documents
CustomerLogoutSigns the current customer out.
@evolve-storefront/feature-auth/documents
CustomerPasswordResetSets a new password with the token from the reset email.
@evolve-storefront/feature-auth/documents
CustomerPasswordResetRequestSends a password reset email to the address given.
@evolve-storefront/feature-auth/documents
Types17
AuthCartMergeWhat a sign-in did with the session's guest cart (schema CartMerge), for feature-cart's CartMergeNotice.
@evolve-storefront/feature-auth
AuthCustomerThe authenticated customer (subset returned by the auth mutations).
@evolve-storefront/feature-auth
AuthenticationErrorCodeAuthenticationError.code (login) — displayed at the form level.
@evolve-storefront/feature-auth
CustomerCreateInputInput for customerCreate (schema CustomerCreateInput).
@evolve-storefront/feature-auth
PasswordResetErrorCodePasswordResetError.code (set-new) — displayed at the form level.
@evolve-storefront/feature-auth
PasswordScoreA password strength score from 0 (weakest) to 4 (strongest).
@evolve-storefront/feature-auth
SalutationOptional salutation (schema Salutation).
@evolve-storefront/feature-auth
LoginFormInput
@evolve-storefront/feature-auth/schemas
PasswordResetFormInput
@evolve-storefront/feature-auth/schemas
PasswordResetRequestFormInput
@evolve-storefront/feature-auth/schemas
RegisterFormInput
@evolve-storefront/feature-auth/schemas
ReturningCustomer
@evolve-storefront/feature-auth/hooks
UseLoginFormResult
@evolve-storefront/feature-auth/hooks
UsePasswordResetFormResult
@evolve-storefront/feature-auth/hooks
UsePasswordResetRequestFormResult
@evolve-storefront/feature-auth/hooks
UseRegisterFormResult
@evolve-storefront/feature-auth/hooks
LoginFormBindingThe props a sign-in hook supplies — spread onto <LoginFormView>.
@evolve-storefront/feature-auth/login-form

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