@liquidcommerce/elements-sdk 2.4.4 → 2.5.0

package/README.md

@@ -791,6 +791,34 @@ const address = actions.address.getDetails();
 actions.address.clear();
 ```
 
+#### Clear Address - Complete Reset
+
+The `actions.address.clear()` action performs a comprehensive reset of the user's address and shopping session:
+
+**What it clears:**
+- ✅ **Address Data**: Removes all saved address information (street, city, state, zip, coordinates)
+- ✅ **Cart Contents**: Completely resets the cart (removes all items, totals, promo codes)
+- ✅ **Local Storage**: Completely removes the localStorage entry and its value
+- ✅ **Database**: Deletes the persisted store from the server database
+- ✅ **Checkout State**: Resets any pending checkout information
+
+**Why it resets the cart:**
+When an address is cleared, the cart must be reset because:
+- Cart items have location-specific pricing and availability
+- Fulfillment options are tied to specific addresses
+- Delivery fees and shipping costs depend on location
+- Without a valid address, cart operations would fail or show incorrect data
+
+**Events fired:**
+- `lce:actions.address_cleared` - Address successfully cleared
+- `lce:actions.cart_reset` - Cart successfully reset
+
+**Use cases:**
+- Guest checkout option (clear previous user's data)
+- Location change (start fresh with new address)
+- Privacy compliance (complete data removal)
+- Testing/development (reset to clean state)
+
 **Notes**: 
 - To find Google Places IDs for the `setAddressByPlacesId` action, use the [Google Places ID Finder](https://developers.google.com/maps/documentation/places/web-service/place-id#find-id)
 - The `setAddressManually` action automatically generates a Google Places API-formatted address string from the provided components