@doswiftly/storefront-sdk 21.0.0 → 22.0.0

package/CHANGELOG.md

@@ -1,5 +1,40 @@
 # Changelog
 
+## 22.0.0
+
+### Major Changes
+
+- 49139e2: Remove the `pendingPoints` field from `LoyaltyPointsSummary` (GraphQL schema, the `LoyaltyPointsSummary` fragment and the generated types). The field was never populated — it always returned `0` — because purchase points are credited directly when the payment is captured, so there is no "pending" state to report.
+
+  **Migration:** if your storefront reads `points.pendingPoints` (or selects `pendingPoints` in a custom query or fragment), remove that usage and re-run your codegen. No replacement field is needed — `currentPoints` has always been the spendable balance.
+
+### Minor Changes
+
+- 49139e2: Referral program signup support — the loyalty referral program now works end-to-end:
+  - `customerSignup` accepts an optional `referralCode` in its input. When the shop's referral program is active, a valid code grants the configured bonus points to the new customer and, after their first paid order, rewards the referrer. An invalid, expired or own code is silently ignored — the signup always succeeds.
+  - New referral capture helpers in the SDK: `useReferralCapture()` / `captureReferralCode()` persist the `?ref=CODE` parameter from a referral landing link into the readable `referral-code` cookie (30 days by default), and `readReferralCodeCookie()` / `clearReferralCodeCookie()` read and clear it at signup time. A server-side `readReferralCodeCookie()` is available from `@doswiftly/storefront-sdk/react/server` for SSR-rendered signup forms. Core constants and the URL extractor (`REFERRAL_COOKIE_NAME`, `REFERRAL_COOKIE_MAX_AGE`, `extractReferralCodeFromUrl`) are exported from the framework-agnostic core entry.
+
+  The cookie lifetime is the _landing → signup_ window and is intentionally independent of the shop's referral validity setting, which starts at signup and is enforced by the API.
+
+## 21.0.1
+
+### Patch Changes
+
+- 65c7f72: Fixed: cart, order, and customer address reads now include `buildingNumber` and `flatNumber`. The previous release added both fields to the schema and inputs (you could send them), but the SDK's `MailingAddress` selection did not request them back — they always came back missing on `cart.shippingAddress` / `cart.billingAddress`, order addresses, the saved address book (`getAddresses()`), and `customer.defaultAddress`. The generated types now carry both fields as well.
+
+  Documentation: rewrote the SDK README to match the current API.
+
+  The README (shown on npm and GitHub) previously described setup patterns from older releases. It now documents the current surface:
+  - **Quick start** based on `createStorefrontAuthRoute` (one route file mounting `login` / `refresh` / `logout` / `whoami`), `getInitialAuth()` server seeding, and `<StorefrontProvider>` with automatic session refresh.
+  - **Cart** chapter covering the capability model (composite `cart-id` cookie carrying the cart access secret, `cartSecretMiddleware`), the full `useCartManager` checkout lifecycle (per-operation recovery table, tagged-union `status`, lifecycle callbacks, `initialCartId`), `<CartManagerProvider>` / `useCartManagerContext()`, completion + payment session creation, discovery queries, `merge` / `downgradeOnLogout` / `recoveryRedeem`, and the framework-agnostic recovery runner.
+  - **Authentication** chapter documenting the session cookie set, proactive + reactive refresh, the BFF sign-in flow, `AuthClient` methods (including `refreshSession()` and `getAddresses()`), and reverse-proxy origin validators.
+  - Reference sections for the middleware pipeline order, debug logging (including the remote debug transport), runtime schema enums, cookie contract constants, format hooks, pre-built components (including payment instrument tiles), and server-side helpers (`readCartCredentials`, `serverCartSecretMiddleware`).
+  - A **Deprecated** section listing the legacy cart store (`createCartStore` / `CartProvider` / `useCartStore`), `AuthClient.refreshToken()` / `useRefreshToken`, and `ShopCurrencyData` with their replacements.
+
+  Also cleaned up developer-facing JSDoc across the package (clients, middleware, stores, hooks, pre-built components): comments and IDE hover text are now plain technical English, and the `getBrowserDataForPayment` example no longer suggests passing browser data to `createPayment` (its input is `{ orderId, returnUrl?, cancelUrl? }`). No runtime changes.
+
+  `@doswiftly/storefront-operations` is version-synced; no code changes.
+
 ## 21.0.0
 
 ### Major Changes