feature-shopping-list 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
ShoppingListContext | The context ShoppingListProvider fills.@evolve-storefront/feature-shopping-list/context |
useShoppingListContext | Read the injected auth/session/business-unit context and dialog openers. @evolve-storefront/feature-shopping-list/context |
useShoppingListScope | Derive the read scope from the injected mode. @evolve-storefront/feature-shopping-list/context |
canReadShoppingLists | Whether the list reads may run: a token exists and the auth layer has settled. @evolve-storefront/feature-shopping-list/context |
resolveShoppingListScope | The read scope for a context value: business, then customer, then anonymous. @evolve-storefront/feature-shopping-list/context |
shoppingListDefaults | What the context holds without a ShoppingListProvider: signed out, and dialog openers that do nothing.@evolve-storefront/feature-shopping-list/context |
ShoppingListContextValue | Injected auth/session/business-unit seam plus dialog controls. @evolve-storefront/feature-shopping-list/context |
GraphQL documents14
AnonymousShoppingListCreate | Creates a shareable list from a set of SKUs and returns its link. @evolve-storefront/feature-shopping-list/queries |
GetAnonymousShoppingList | A shared shopping list, by the id in its share link. @evolve-storefront/feature-shopping-list/queries |
GetBusinessShoppingListDetail | One of a business unit's shopping lists, with its lines. @evolve-storefront/feature-shopping-list/queries |
GetBusinessShoppingLists | A business unit's shopping lists. @evolve-storefront/feature-shopping-list/queries |
GetCustomerShoppingListDetail | One of the signed-in customer's shopping lists, with its lines. @evolve-storefront/feature-shopping-list/queries |
GetCustomerShoppingLists | The signed-in customer's shopping lists. @evolve-storefront/feature-shopping-list/queries |
GetGuestShoppingLists | The current session's shopping lists, for a guest. @evolve-storefront/feature-shopping-list/queries |
GetShoppingListDetail | One of the current session's shopping lists, with its lines. @evolve-storefront/feature-shopping-list/queries |
ShoppingListCreate | Creates a shopping list. @evolve-storefront/feature-shopping-list/queries |
ShoppingListDelete | Deletes a shopping list. @evolve-storefront/feature-shopping-list/queries |
ShoppingListLineItemsAdd | Adds products to a shopping list. @evolve-storefront/feature-shopping-list/queries |
ShoppingListLineItemsRemove | Removes lines from a shopping list. @evolve-storefront/feature-shopping-list/queries |
ShoppingListLineItemsUpdate | Changes the quantity of lines in a shopping list. @evolve-storefront/feature-shopping-list/queries |
ShoppingListUpdate | Renames a shopping list or changes its description. @evolve-storefront/feature-shopping-list/queries |
Data and cache helpers9
findLineItemId | The line-item id of the SKU within a specific list, if present. @evolve-storefront/feature-shopping-list |
findShoppingListEntry | Find the shopping list that already contains the given variant SKU. @evolve-storefront/feature-shopping-list |
invalidateDetail | Invalidate a single list's detail cache. @evolve-storefront/feature-shopping-list |
invalidateOverview | Invalidate every overview cache for a scope (all pages). @evolve-storefront/feature-shopping-list |
isInAnyShoppingList | True when the SKU is in any of the given lists. @evolve-storefront/feature-shopping-list |
removeItemFromDetailCache | Optimistically drop a line item from a cached detail list. @evolve-storefront/feature-shopping-list |
shoppingListTotal | The sum of each priced line's unit price times its quantity, in one tax basis. @evolve-storefront/feature-shopping-list |
updateDetailCache | Merge a partial list into a cached detail list. @evolve-storefront/feature-shopping-list |
shoppingListKeys | react-query key factory for the overview and detail caches. @evolve-storefront/feature-shopping-list |
Schemas1
ShoppingListFormSchema | The one schema a create/edit form validates against — exported so the backend (and any consumer) reuses the exact same shape. @evolve-storefront/feature-shopping-list/schemas |
Other functions and constants2
ShoppingListCreateDialog | Modal create form. @evolve-storefront/feature-shopping-list/provider |
ShoppingListEditDialog | Modal rename/re-describe form. @evolve-storefront/feature-shopping-list/provider |
Types26
FieldValidationIssue | @evolve-storefront/feature-shopping-list |
Money | Money (schema Money): minor units and an ISO currency.@evolve-storefront/feature-shopping-list |
ShoppingList | A shopping list with its full line items (detail view). @evolve-storefront/feature-shopping-list |
ShoppingListAvailability | The schema's ProductAvailabilityType, verbatim.@evolve-storefront/feature-shopping-list |
ShoppingListDeleteResult | Delete returns a success flag instead of the (now-gone) list. @evolve-storefront/feature-shopping-list |
ShoppingListInput | Input for creating or updating a list (name required, description optional). @evolve-storefront/feature-shopping-list |
ShoppingListLineItem | @evolve-storefront/feature-shopping-list |
ShoppingListLineItemAddInput | @evolve-storefront/feature-shopping-list |
ShoppingListLineItemUpdateInput | @evolve-storefront/feature-shopping-list |
ShoppingListMutationError | Every shopping-list mutation's error union is ValidationError.@evolve-storefront/feature-shopping-list |
ShoppingListMutationResult | Shared write response: the entity plus the typed error array. @evolve-storefront/feature-shopping-list |
ShoppingListOverviewItem | Lighter shape used by the overview query to detect membership. @evolve-storefront/feature-shopping-list |
ShoppingListPrice | A single-rate taxed price (schema TaxedPrice), without its tax line.@evolve-storefront/feature-shopping-list |
ShoppingListScope | Which set of lists a surface reads. @evolve-storefront/feature-shopping-list |
ShoppingListsOverview | Paginated list overview (schema ShoppingListResult).@evolve-storefront/feature-shopping-list |
ShoppingListTotal | What a list comes to, and how many of its lines have no price to count. @evolve-storefront/feature-shopping-list |
ShoppingListVariant | @evolve-storefront/feature-shopping-list |
ValidationError | @evolve-storefront/feature-shopping-list |
AnonymousShoppingListCreateResult | @evolve-storefront/feature-shopping-list/queries |
ShoppingListFormInput | @evolve-storefront/feature-shopping-list/schemas |
UseActiveShoppingListResult | The active-list selection plus its setter, as consumed by the picker. @evolve-storefront/feature-shopping-list/hooks |
ShoppingListDetailItemApi | Bound actions handed to renderItem, so the consumer supplies only the markup while the id handshake and mutations stay inside the feature.@evolve-storefront/feature-shopping-list/shopping-list-detail |
ShoppingListDetailItemRenderer | Renders a single line item. @evolve-storefront/feature-shopping-list/shopping-list-detail |
ShoppingListOverviewItemRenderer | Renders one list in the overview grid. @evolve-storefront/feature-shopping-list/shopping-list-overview |
ShoppingListFormContextValue | Context seeded by ShoppingListForm so the composed pieces (Fields, Submit) read what they need without prop-drilling — which lets the dialog own the DialogFooter (and the submit button inside it) instead of the generic form importing anything dialog-specific.@evolve-storefront/feature-shopping-list/shopping-list-form |
ShoppingListFormFieldErrors | A validationErrors map keyed by field name, as RAC's Form consumes it.@evolve-storefront/feature-shopping-list/shopping-list-form |
Not listed: 19 props and options types. They appear as the tables on the pages of what they type.